We are glad you are reading this, because we need volunteer developers to help this project come to fruition.
If you don't have anything you are working on we have a list of newbie friendly issues you can help out with.
If you haven't already, come find us on our mailing list. We want you working on things you're excited about.
Harvey, like most other open source projects, has a Code of Conduct that it expects its contributors and core team members to adhere to.
Here are some important resources:
We make use Travis-CI and make sure we can build your pull-requests before we can accept your contributions.
Harvey uses Github Pull Requests to accept contributions.
git clone https://github.com/Harvey-OS/harvey.git. It is also possible to use
httpsif you have an SSH public key stored on Github:
git clone firstname.lastname@example.org:Harvey-OS/harvey.git. This makes submitting contributions easier. For the rest of this manual we assume to use https.
git checkout -b feature-name. For example, @keedon selected the branch name
statscrashfor issue #70.
$ git commit -m "A brief summary of the commit > > A paragraph describing what changed and its impact."For a representative example, look at @keedon's commit message for issue #70 mentioned above. You can also use graphical git tools such as
git guiif you like.
Add the repo as a remote (every time you clone the repository)
git remote add yourname https://github.com/yourusername/harvey.git
where "yourname" is your github login name.
git remote -v should look like this:
$ git remote -v yourname https://github.com/yourname/harvey.git (fetch) yourname https://github.com/yourname/harvey.git (push) origin https://github.com/Harvey-OS/harvey.git (fetch) origin https://github.com/Harvey-OS/harvey.git (push)
Push your branch to your forked repository:
git push yourname feature-name
Add details of what you have worked on and your motivation.
When you send a pull request, we greatly appreciate if you include
emu output and additional tests: we can always use more test
coverage. Please follow our coding conventions and make sure all
of your commits are atomic in the sense of having one feature per
git pull yourname feature-nameand update your local repo before committing more changes.
If you're working in a branch that is outdated with respect to the
master branch, just do a
git pull --rebase. This will put your
changes after the pull. In the case that there would be conflicts, you
will have to solve them manually, but they are marked with something
>>>>>HEAD" and git will tell you about which files are in
If you read the code you should get a hang of it but a loose listing of our Style-Guide exists, we recommend you check it out.
We have also automated the process via clang-format so before you submit a change please format your diff.
Adopted from Open Government Contribution Guidelines