CONTRIBUTING.md

Contributing

PYDAQ is intended to be a community project. You are more than welcome to contribute!

Bug reporting and New Features

If you find any bugs or have suggestions for new features, please report them on issue tracker on GitHub.

Documentation

Documentation is as important as the library itself and PYDAQ documentation can be found here. English is not my primary language, so if you find any typo or wrong phrases, do not hesitate to point me out.

Development environment

These are some basic steps to help us with coding:

1. Install and Setup Git on your computer.
2. Fork PYDAQ
3. Clone the fork on your local machine
4. Install it in editable mode using

   pip install -e /path/to/pydaq

5. Create a new branch.
6. Make changes following the coding style of the project (or suggesting improvements).
7. Run the tests.
8. Write and/or adapt existing test if needed.
9. Add documentation if needed.
10. Commit.
11. Push to your fork
12. Open a pull request!