Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

51 lines (40 loc) · 2.28 KB

Contributing

If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository. After this you can help by fixing it submitting a pull request (PR). Please, try to follow these guidelines when you do so.

Issue reporting

  • Check that the issue has not already been reported.
  • Check that the issue has not already been fixed in the latest code (a.k.a. master). So be certain that you are using latest master code version (not latest released version). Installing latest development version can be done using:
$ pip install git+https://github.com/python-windrose/windrose

or

$ git clone https://github.com/python-windrose/windrose
$ python setup.py install
  • Be clear, concise and precise in your description of the problem.
  • Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.
  • Mention your Python version and operating system.
  • Include any relevant code to the issue summary. A Minimal Working Example (MWE) can help.

Reporting bugs

When reporting bugs it's a good idea to provide stacktrace messages to the bug report makes it easier to track down bugs. Some steps to reproduce a bug reliably would also make a huge difference.

Pull requests