2.4 KiB
2.4 KiB
Contributing guidelines to openDBM
Please visit openDBM page if you have not seen it. If you are enthusiastic to contribute to this toolkit in terms of bug fixes, tutorials, new feature development, enhancing existing features etc. everything should be managed by submitting pull request on Github.
What you should know
- Read code of conduct.
- Read issues.
- Read License.
- Agree to contribute code under openDBM(GPL v3.0).
- Before adding new feature/algorithmn make sure it's not patented.
- Before fixing any bug make sure it's still exists and reproducable in master branch.
- If you see any issue in existing features make sure to report the issue on openDBM issues page.
- After adding new code make sure everything is working as expected.
How to contribute
- Install Git.
- Register and signin into GitHub.
- Fork openDBM repository https://github.com/AiCure/open_dbm.git (https://help.github.com/articles/fork-a-repo for details)
- Assign a task for yourself. It could be a bugfix or adding new functionality.
- Clone your fork into your local system.
- Navigate to local repository.
- Check that your fork is the 'origin' remote.
- Use 'git remote -v' to show current remote
- If you do not see any remote, add it using git remote add origin
- Add openDBM master repository as 'upstream' remote.
- Use 'git remote add upstream https://github.com/AiCure/open_dbm.git' command
- Check remote using 'git remote -v'
- Before making any changes better to synchronize local repository with openDBM master
- git pull upstream master
- Create new branch where you are going to add bugfix or new features
- git checkout -b branch_name
- Make and commit your changes into local repository
- Validate all your commits and make sure everything is working as expected.
- Push your chanhes to new branch(which is a branch of fork repository)
- git push origin branch_name
- Create a pull request and add brief information about all your commits.(see https://help.github.com/articles/using-pull-requests for details)
Request Approval
Once reviewer is happy with the code changes, will approve the pull request and merge it with the master branch.