To alter the source code, I've adopted a gitflow Feature branching strategy.
For experts:
Master – The master code for the the current release, If all else fails, this is what things should be reset to.
- hotfix/ - intended for emergency updates to the latest release, allowing ability to bypass the develop branch. (Not normally needed for this project)
Develop – The next point release. for example if version 0.5.0.0 has been released, develop will be 0.6.0.0
- feature/ - Normal feature branches, intended for development of normal code alterations.
Make a Pull request, for the feature branch to be squash merged to develop. Once merged the feature branch will be deleted, and the code will be part of the next release, when it gets merged to master.
For beginners:
When you clone the repository, you will get the develop branch by default. From that branch you'll need to create a branch using the style feature/ Changing something to a descriptive name for your branch. You can then make the changes that you'd like to the driver.
When you commit the changes and push them into the repository, the Teamcity server will come to life, it will build the code, run the unit tests and produce a report. If everything is good, you'll even get access to the build artifacts, which contains an installer containing your branches build of the driver, so that you can test it on a non development system. note: this will not be an official release, but will be a real build of your branch.
Once you are happy with the changes that you've made, and the teamcity build process completes without issues. Make a Pull request. This will be the signal that you will be wanting the code to be merged into the main codebase. I'll review the code, work with you to make sure that it is good for inclusion in the main source code. At this point the Pull request will be merged, and your branch deleted from the repo. You code will then be part of the Develop branch.
At this point, I'll most likely merge develop into master and trigger a production build making your changes part of an official release, this will be published on the website for everyone.