Skip to content

Commit

Permalink
Merge branch 'release/1.2.0'
Browse files Browse the repository at this point in the history
  • Loading branch information
dermatologist committed Jul 28, 2020
2 parents 671fe4c + c076898 commit cf6a051
Show file tree
Hide file tree
Showing 11 changed files with 7,512 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
bin
.idea
.vscode
cdmtest.*
gocdm
cdmtest.*
70 changes: 70 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# How to contribute

## Please note:

* (Optional) We adopt [Git Flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow). Most feature branches are pushed to the repository and deleted when merged to *develop* branch.
* (**Important**): Submit pull requests to the *develop* branch or *feature/* branches
* Use *GitHub Issues* for feature requests and bug reports. Include as much information as possible while reporting bugs.


## Contributing (Step-by-step)

1. [Fork the repo](http://help.github.com/fork-a-repo) and clone it to your local computer, and set up the upstream remote:

git clone https://github.com/YourGithubUsername/gocdm.git
cd gocdm
git remote add upstream https://github.com/E-Health/gocdm.git

2. Checkout out a new local branch based on your master and update it to the latest (TRUNK-123 is the branch name, You can name it whatever you want. Try to give it a meaningful name. If you are fixing an issue, please include the issue #).

git checkout -b BRANCH-123 develop
git clean -df
git pull --rebase upstream develop

> Please keep your code clean. If you find another bug, you want to fix while being in a new branch, please fix it in a separated branch instead.
3. Push the branch to your fork. Treat it as a backup.

git push origin BRANCH-123

4. Code

* Adhere to common conventions you see in the existing code.
* Include tests as much as possible, and ensure they pass.

5. Commit to your branch

git commit -m "BRANCH-123: Put change summary here (can be a ticket title)"

**NEVER leave the commit message blank!** Provide a detailed, clear, and complete description of your commit!

6. Update your branch to the latest code.

git pull --rebase upstream develop

7. **Important** If you have made many commits, please squash them into atomic units of work. (Most Git GUIs such as sourcetree and smartgit offer a squash option)

git checkout develop
git pull --rebase upstream develop
git merge --squash BRANCH-123
git commit -m "fix: 123"

Push changes to your fork:

git push

8. Issue a Pull Request

In order to make a pull request:
* Click "Pull Request".
* Choose the develop branch
* Click 'Create pull request'
* Fill in some details about your potential patch including a meaningful title.
* Click "Create pull request".

Thanks for that -- we'll get to your pull request ASAP. We love pull requests!

## Feedback

If you need to contact me, see my contact details on my profile page.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Bell Raj Eapen

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ The [OHSDI](https://www.ohdsi.org/) OMOP Common Data Model allows for the system

### see *main.go* for usage examples

### [documentation](https://e-health.github.io/gocdm/pkg/github.com/E-Health/gocdm/)

### APIs (example for Person)

GET /people
Expand Down
Loading

0 comments on commit cf6a051

Please sign in to comment.