Skip to content

Commit

Permalink
Update CONTRIBUTING.rst (#582)
Browse files Browse the repository at this point in the history
  • Loading branch information
WasabiFan authored and dwalton76 committed Dec 23, 2018
1 parent aad7f66 commit 055ba0d
Showing 1 changed file with 16 additions and 33 deletions.
49 changes: 16 additions & 33 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,24 @@ devices that use the drivers available in the ev3dev_ distribution.
for embedded systems.

Contributions are welcome in the form of pull requests - but please
take a moment to read our suggestions for a happy maintainer (me) and
take a moment to read our suggestions for happy maintainers and
even happier users.

The ``master`` branch
The ``ev3dev-stretch`` branch
---------------------

This is where the latest tagged version lives - it changes whenever
we release a tag that gets released.

The ``develop`` branch
----------------------

This is the branch that is undergoing active development intended
for the next tagged version that gets released to ``master``.

Please make sure that your pull requests are against the
``develop`` branch.
This is where the latest version of our library lives. It targets
`ev3dev-stretch`, which is currently considered a beta. Nonetheless,
it is very stable and isn't expected to have significant breaking
changes. We publish releases from this branch.

Before you issue a Pull Request
-------------------------------

This is a hobby for me, I get no compensation for the work I do
on this repo or any other contributions to ev3dev_. That does not
make me special, it's the same situation that everyone involved
in the project is in.

Therefore, do not count on me to test your PR before I do the
merge - I will certainly review the code and if it looks OK I will
just merge automatically.

I would ask that you have at least tested your changes by running
a test script on your target of choice as the generic ``robot`` user
that is used by the ``Brickman`` UI for ev3dev_.

Please do not run as ``root`` or your own user that may have group
memberships or special privileges not enjoyed by ``robot``.
Sometimes, it isn't easy for us to pull your suggested change and run
rigorous testing on it. So please help us out by validating your changes
and mentioning what kinds of testing you did when you open your PR.
Please also consider adding relevant tests to `api_tests.py`.

If your change breaks or changes an API
---------------------------------------
Expand All @@ -50,9 +32,9 @@ Breaking changes are discouraged, but sometimes they are necessary. A
more common change is to add a new function or property to a class.

Either way, if it's more than a bug fix, please add enough text to the
comments in the pull request message so that I can paste it into the
draft release notes that I keep running for the next release out of
master.
comments in the pull request message so that we know what was updated
and can easily discuss the breaking change and add it to the release
notes.

If your change addresses an Issue
---------------------------------
Expand All @@ -61,8 +43,9 @@ Bug fixes are always welcome, especially if they are against known
issues!

When you send a pull request that addresses an issue, please add a
note something like ``Fixes #24`` in the PR so that we get linkage
back to the specific issue.
note of the format ``Fixes #24`` in the PR so that the PR links back
to its relevant issue and will automatically close the issue when the
PR is merged.

.. _ev3dev: http://ev3dev.org

0 comments on commit 055ba0d

Please sign in to comment.