Skip to content

Latest commit

 

History

History
57 lines (43 loc) · 2.08 KB

CONTRIBUTING.rst

File metadata and controls

57 lines (43 loc) · 2.08 KB

How to Contribute

Getting help

To ask questions about the XBee Python library go to the Digi Forum.

Reporting a bug

The way to report bugs is to use the GitHub issue tracker. Before reporting a bug, please read the following points:

  1. Make sure that what you are seeing is really a bug by checking the documentation and consulting the FAQs section.
  2. If you still think you have found a bug, make sure someone has not already reported it. See the list of known issues.
  3. If it has not been reported yet, create a new issue. Make sure to add enough detail so that the bug can be reproduced.

Note

The issue tracker is for bugs, not requests for help. Questions should be asked on the Digi Forum instead.

Suggesting a new feature

  1. Consult the FAQs section to ensure that the behavior you would like the library to have is not excluded.
  2. Make sure someone has not already requested it. See the list of known issues.
  3. Submit your request in the issue tracker.

Contributing code

  1. Fork the XBee Python library repository (how to fork a repo).
  2. Create a branch for your contribution. Use a name that defines the purpose of the additions/modifications.
  3. Make your changes following the code style used in the library.
  4. Submit a pull request (how to create a pull request). A project developer will review your work and then merge your request into the project, or come back to you with comments and/or questions.