|
|
@@ -2,6 +2,8 @@
|
|
|
|
|
|
I'm really glad you're 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**](https://github.com/Harvey-OS/harvey/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+label%3A%22newbie+friendly%22) you can help out with.
|
|
|
+
|
|
|
If you haven't already, come find us on our [mailing list](https://groups.google.com/forum/#!forum/harvey). We want you working on things you're excited about.
|
|
|
|
|
|
Harvey, like most other open source projects, has a [Code of Conduct](https://github.com/Harvey-OS/harvey/wiki/Code-of-Conduct) that it expects its contributors and core team members to adhere to.
|
|
|
@@ -22,11 +24,8 @@ We make sure Travis-CI can build your pull-requests before we can accept your co
|
|
|
Harvey uses Github Pull Requests to accept contributions.
|
|
|
|
|
|
1. Clone the repo `git clone https://github.com/Harvey-OS/harvey.git`. It is also possible to use git instead of https when you have an SSH public key stored in Github. Then you clone the repo with `git clone git@github.com:Harvey-OS/harvey.git`. This makes later submissions easier. For the rest of this manual we assume to use https.
|
|
|
-
|
|
|
2. Check out a feature branch you will work on by `git checkout -b feature-name` for instance for issue #70, @keedon selected the branch name `statscrash`.
|
|
|
-
|
|
|
3. Make changes
|
|
|
-
|
|
|
4. Commit with a descriptive message, like so
|
|
|
```
|
|
|
$ git commit -m "A brief summary of the commit
|
|
|
@@ -35,10 +34,8 @@ Harvey uses Github Pull Requests to accept contributions.
|
|
|
```
|
|
|
take a look at @keedon's [commit message](https://github.com/keedon/harvey/commit/09fe3a21fa8b42088bc8ad83287928e9e7cc96ef) for the same issue for a good example of a descriptive commit message.
|
|
|
You can also use graphical git tools such as `git gui` which make commiting changes easier.
|
|
|
-
|
|
|
5. Fork the repo (only once).
|
|
|
|
|
|
-
|
|
|
6. Add the repo as a remote (every time you clone the repo)
|
|
|
|
|
|
`git remote add yourname https://github.com/yourusername/harvey.git`
|
|
|
@@ -53,12 +50,9 @@ Harvey uses Github Pull Requests to accept contributions.
|
|
|
origin https://github.com/Harvey-OS/harvey.git (fetch)
|
|
|
origin https://github.com/Harvey-OS/harvey.git (push)
|
|
|
```
|
|
|
-
|
|
|
7. Push your branch to your forked repo like so `git push yourname feature-name`
|
|
|
-
|
|
|
8. Create a pull request by going to `https://github.com/yourname/harvey/pull/new/feature-name` or clicking the PR button
|
|
|
|
|
|
-
|
|
|
9. Add details of what you have worked on and what your intentions are.
|
|
|
|
|
|
When you send a pull request, we will love you forever if you include qemu outputs and more tests. We can always use more test coverage. Please follow our coding conventions (below) and make sure all of your commits are atomic (one feature per commit).
|
|
|
@@ -76,14 +70,6 @@ Harvey uses Github Pull Requests to accept contributions.
|
|
|
|
|
|
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 like ">>>>>HEAD" and git will tell you about which files are conflicting.
|
|
|
|
|
|
-## Coding conventions
|
|
|
-
|
|
|
-If you read the code you should get a hang of it but a loose listing of our [Style-Guide](https://github.com/Harvey-OS/harvey/wiki/Style-Guide) exists, we recommend you check it out.
|
|
|
-
|
|
|
-We have also automated the process via [clang-format](http://clang.llvm.org/docs/ClangFormat.html) so before you submit a change please format your diff.
|
|
|
-
|
|
|
-[How to clang-format a diff](http://clang.llvm.org/docs/ClangFormat.html#script-for-patch-reformatting)
|
|
|
-
|
|
|
#### More information
|
|
|
|
|
|
- [How to use Pull Requests](http://help.github.com/pull-requests/)
|
|
|
@@ -95,4 +81,14 @@ We have also automated the process via [clang-format](http://clang.llvm.org/docs
|
|
|
- [Video: Undo, Redo & Rebase Your Git History](https://www.youtube.com/watch?v=W39CfI3-JFc)
|
|
|
- [Video: Git Rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo)
|
|
|
|
|
|
+
|
|
|
+## Coding conventions
|
|
|
+
|
|
|
+If you read the code you should get a hang of it but a loose listing of our [Style-Guide](https://github.com/Harvey-OS/harvey/wiki/Style-Guide) exists, we recommend you check it out.
|
|
|
+
|
|
|
+We have also automated the process via [clang-format](http://clang.llvm.org/docs/ClangFormat.html) so before you submit a change please format your diff.
|
|
|
+
|
|
|
+[How to clang-format a diff](http://clang.llvm.org/docs/ClangFormat.html#script-for-patch-reformatting)
|
|
|
+
|
|
|
+
|
|
|
_Adopted from [Open Government Contribution Guidelines](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md)_
|
Sevki