File: CONTRIBUTING.rst

package info (click to toggle)
pyserial-asyncio 0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 184 kB
  • sloc: python: 416; makefile: 79
file content (46 lines) | stat: -rw-r--r-- 1,557 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
==============
 Contributing
==============

How Can I Contribute?
=====================

Reporting Bugs and Suggesting Enhancements
    The easiest is creating an issue_. You can do that for ideas or problems.

    For bugs, if possible, try to construct a small code example that exhibits
    the problem. Include version numbers (Python, pySerial,
    pySerial-asyncio).

Pull Requests
    Code / test / documentation contributions are of course welcome_!

    Consider that this is a project that aims to run on many platforms and
    architectures and therefore needs implementations covering all of them, of
    course there are exceptions and starting on one platform is better than
    starting on none.

    When providing new features, also think of documentation and tests if
    possible.


Ownership
=========

- By contributing to this project, you agree that the material is labeled as
  "copyright by pySerial-team". Names or handles of individual contributors are
  listed in a separate file: CREDITS.rst_.

- Your contribution may be used in its original or modified form.

- The project maintainer(s) can make decisions in the name of
  the pySerial-team. Including but not limited to:

  - making releases, adding/removing features, changing the design, etc.
  - adding or removing project maintainers
  - license changes, as long as it remains a permissive open source license.


.. _CREDITS.rst: CREDITS.rst
.. _issue: https://github.com/pyserial/pyserial-asyncio/issues
.. _welcome: https://github.com/pyserial/pyserial-asyncio/pulls