|
| 1 | +Contributing to the Python language bindings for ev3dev |
| 2 | +======================================================= |
| 3 | + |
| 4 | +This repository holds the pure Python bindings for peripheral |
| 5 | +devices that use the drivers available in the ev3dev_ distribution. |
| 6 | +for embedded systems. |
| 7 | + |
| 8 | +Contributions are welcome in the form of pull requests - but please |
| 9 | +take a moment to read our suggestions for a happy maintainer (me) and |
| 10 | +even happier users. |
| 11 | + |
| 12 | +The ``master`` branch |
| 13 | +--------------------- |
| 14 | + |
| 15 | +This is where the latest tagged version lives - it changes whenever |
| 16 | +we release a tag that gets released. |
| 17 | + |
| 18 | +The ``develop`` branch |
| 19 | +---------------------- |
| 20 | + |
| 21 | +This is the branch that is undergoing active development intended |
| 22 | +for the next tagged version that gets released to ``master``. |
| 23 | + |
| 24 | +Please make sure that your pull requests are against the |
| 25 | +``develop`` branch. |
| 26 | + |
| 27 | +Before you issue a Pull Request |
| 28 | +------------------------------- |
| 29 | + |
| 30 | +This is a hobby for me, I get no compensation for the work I do |
| 31 | +on this repo or any other contributions to ev3dev_. That does not |
| 32 | +make me special, it's the same situation that everyone involved |
| 33 | +in the project is in. |
| 34 | + |
| 35 | +Therefore, do not count on me to test your PR before I do the |
| 36 | +merge - I will certainly review the code and if it looks OK I will |
| 37 | +just merge automatically. |
| 38 | + |
| 39 | +I would ask that you have at least tested your changes by running |
| 40 | +a test script on your target of choice as the generic ``robot`` user |
| 41 | +that is used by the ``Brickman`` UI for ev3dev_. |
| 42 | + |
| 43 | +Please do not run as ``root`` or your own user that may have group |
| 44 | +memberships or special privileges not enjoyed by ``robot``. |
| 45 | + |
| 46 | +If your change breaks or changes an API |
| 47 | +--------------------------------------- |
| 48 | + |
| 49 | +Breaking changes are discouraged, but sometimes they are necessary. A |
| 50 | +more common change is to add a new function or property to a class. |
| 51 | + |
| 52 | +Either way, if it's more than a bug fix, please add enough text to the |
| 53 | +comments in the pull request message so that I can paste it into the |
| 54 | +draft release notes that I keep running for the next release out of |
| 55 | +master. |
| 56 | + |
| 57 | +If your change addresses an Issue |
| 58 | +--------------------------------- |
| 59 | + |
| 60 | +Bug fixes are always welcome, especially if they are against known |
| 61 | +issues! |
| 62 | + |
| 63 | +When you send a pull request that addresses an issue, please add a |
| 64 | +note something like ``Fixes #24`` in the PR so that we get linkage |
| 65 | +back to the specific issue. |
| 66 | + |
| 67 | +.. _ev3dev: http://ev3dev.org |
| 68 | + |
0 commit comments