When contributing to CarpeDM, please first discuss the change you wish to make via github issue, email, or any other method with the owner of this repository before making a change.
Please note we have a Code of Conduct, please follow it in all your interactions with the project.
Fork the repository.
Clone the fork to your local machine:
$ git clone https://github.com/YOUR-USERNAME/carpedm
Add an upstream remote for syncing with the master repo:
$ cd carpedm $ git remote add upstream https://github.com/SimulatedANeal/carpedm
Make sure your repository is up to date with
$ git pull upstream master
(Create a topical branch):
$ git checkout -b branch-name
Make your changes.
Again, make sure your repo is up to date.
Push to your forked repo:
$ git push origin branch-name
Make Pull Request.
- Make changes as directed above.
CHANGES.mdwith details of changes to the interface.
- Increase the
carpedm.__init__.pyto the new version number that this Pull Request would represent. The versioning scheme we use is SemVer.
- You may merge the Pull Request in once you have the sign-off of the lead developer, or if you do not have permission to do that, you may request the reviewer to merge it for you.