Permalink
Browse files

Update CONTRIBUTING.md.

  • Loading branch information...
1 parent 706d3b2 commit e457300569604dd9a9ab3163849aaa8dae753f37 @eugeneia eugeneia committed Apr 28, 2016
Showing with 17 additions and 5 deletions.
  1. +17 −5 CONTRIBUTING.md
View
@@ -1,18 +1,30 @@
-Whenever you create a Pull Request (PR), a maintainer will self-assign
+# Hints for Contributors
+
+* Whenever you create a Pull Request (PR), a maintainer will self-assign
themselves as the *upstream*. The upstream decides if your PR is accepted and
might require you to amend additional changes before merging. You can expect
the upstream to communicate clearly if there are any issues preventing your PR
from being merged, and how they can be fixed. Once merged, the upstream will
-add the `merged` label to your PR.
+add the `merged` label to your PR. More on [our Git workflow](https://github.com/snabbco/snabb/blob/master/src/doc/git-workflow.md).
+
+* Target your PR against the branch you would like it to be merged into. Refer
+to the [list of subsystem branches](https://github.com/snabbco/snabb/blob/master/src/doc/branches.md).
+When in doubt use `master`.
-You are also welcome to submit PRs you would like to receive feedback on, but
+* Feel free to @ping the assignee if you feel like your PR has been overlooked,
+and are waiting for a response.
+
+* You are also welcome to submit PRs you would like to receive feedback on, but
which are not ready to be merged: include the labels `[wip]` in the title of
PRs that require further work, and `[sketch]` for PRs that are not meant to be
merged at all.
-Our [Documentation Guide](https://github.com/SnabbCo/snabbswitch/blob/master/src/doc/documentation-guide.md)
+* Please make sure your editor is configured to not emit tabs and use three
+spaces for indentation.
+
+* Our [Documentation Guide](https://github.com/SnabbCo/snabbswitch/blob/master/src/doc/documentation-guide.md)
gives pointers on how to contribute to the project's documentation.
-If you wish to record a copyright notice with your contribution then you can
+* If you wish to record a copyright notice with your contribution then you can
optionally do this in the file `src/COPYRIGHT`; copyright notices in other
files will be rejected.

0 comments on commit e457300

Please sign in to comment.