Welcome to report Issues or pull requests. It's recommended to read the following Contributing Guide first before contributing.
We use Github Issues to track public bugs and feature requests.
Please search the existing issues to see if any similar issue or feature request has already been filed. You should make sure your issue isn't redundant.
If you open an issue, the more information the better. Such as detailed description, screenshot or video of your problem, logcat and xlog or code blocks for your crash.
We strongly welcome your pull request to make MedicalNet better.
There are three main branches here:
master
branch.- It is the latest (pre-)release branch. We use
master
for tags, with version number1.1.0
,1.2.0
,1.3.0
... - Don't submit any PR on
master
branch.
- It is the latest (pre-)release branch. We use
develop
branch.- It is our stable developing branch. After full testing,
develop
will be merged tomaster
branch for the next release. - You are recommended to submit bugfix or feature PR on
develop
branch.
- It is our stable developing branch. After full testing,
hotfix
branch.- It is the latest tag version for hot fix. If we accept your pull request, we may just tag with version number
1.1.1
,1.2.3
. - Only submit urgent PR on
hotfix
branch for next specific release.
- It is the latest tag version for hot fix. If we accept your pull request, we may just tag with version number
Normal bugfix or feature request should be submitted to develop
branch. After full testing, we will merge them to master
branch for the next release.
If you have some urgent bugfixes on a published version, but the master
branch have already far away with the latest tag version, you can submit a PR on hotfix. And it will be cherry picked to develop
branch if it is possible.
master
¡ü
develop <--- hotfix PR
¡ü
feature/bugfix PR
The code team will monitor all pull request, we run some code check and test on it. After all tests passed, we will accecpt this PR. But it won't merge to master
branch at once, which have some delay.
Before submitting a pull request, please make sure the followings are done:
- Fork the repo and create your branch from
master
orhotfix
. - Update code or documentation if you have changed APIs.
- Add the copyright notice to the top of any new files you've added.
- Check your code lints and checkstyles.
- Test and test again your code.
- Now, you can submit your pull request on
develop
orhotfix
branch.
- 4 spaces for indentation rather than tabs
- private function should start with "__".
- function parameters should start with "_".
By contributing to MedicalNet, you agree that your contributions will be licensed under its MIT LICENSE