pyFAI/CONTRIBUTING.md

970 B

Contributing

When contributing to this repository, please first open an issue to discuss the change you wish to make. Mention you wish to help us improving this specific part of the project, we will be able to provide you guidance.

If you have questions, the best is to subscribe to the associated mailing list. Direct contact with maintainers is discouraged as we are few and may be unavailable (holidays, ...).

Pull Request Process

  1. Ensure the idea is described in an issue before starting to code
  2. Fork the master branch into a meaningfull name (relative to the issue number or name)
  3. Ensure your contributed code has an associated test, documentation and does not create regression
  4. Push your code and create pull-request. This will trigger CI on all operating systems
  5. A core developer may read your code and review it. The PR comments are used to discuss technically your PR's code

Please note we have not yet decided for a code of conduct.