|
| 1 | +============== |
| 2 | + Contributing |
| 3 | +============== |
| 4 | + |
| 5 | +How Can I Contribute? |
| 6 | +===================== |
| 7 | + |
| 8 | +Reporting Bugs and Suggesting Enhancements |
| 9 | + The easiest is creating an issue_. You can do that for ideas or problems. |
| 10 | + |
| 11 | + For bugs, if possible, try to construct a small code example that exhibits |
| 12 | + the problem. Include version numbers (Python, pySerial, |
| 13 | + pySerial-asyncio). |
| 14 | + |
| 15 | +Pull Requests |
| 16 | + Code / test / documentation contributions are of course welcome_! |
| 17 | + |
| 18 | + Consider that this is a project that aims to run on many platforms and |
| 19 | + architectures and therefore needs implementations covering all of them, of |
| 20 | + course there are exceptions and starting on one platform is better than |
| 21 | + starting on none. |
| 22 | + |
| 23 | + When providing new features, also think of documentation and tests if |
| 24 | + possible. |
| 25 | + |
| 26 | + |
| 27 | +Ownership |
| 28 | +========= |
| 29 | + |
| 30 | +- By contributing to this project, you agree that the material is labeled as |
| 31 | + "copyright by pySerial-team". Names or handles of individual contributors are |
| 32 | + listed in a separate file: CREDITS.rst_. |
| 33 | + |
| 34 | +- Your contribution may be used in its original or modified form. |
| 35 | + |
| 36 | +- The project maintainer(s) can make decisions in the name of |
| 37 | + the pySerial-team. Including but not limited to: |
| 38 | + |
| 39 | + - making releases, adding/removing features, changing the design, etc. |
| 40 | + - adding or removing project maintainers |
| 41 | + - license changes, as long as it remains a permissive open source license. |
| 42 | + |
| 43 | + |
| 44 | +.. _CREDITS.rst: CREDITS.rst |
| 45 | +.. _issue: https://github.com/pyserial/pyserial-asyncio/issues |
| 46 | +.. _wellcome: https://github.com/pyserial/pyserial-asyncio/pulls |
0 commit comments