Skip to content

Requesting features, reporting bugs and contributing to Pyccuracy

Diogo Baeder edited this page May 19, 2013 · 1 revision

This document is about Pyccuracy, not the GitHub project. If you ended up in this page, while trying to open an issue in the GitHub project, please continue searching for their page.

Requesting features

Cool project, but Hey I want feature “XYZ”! No problem, not at all! We really want to make this project as usable and useful as possible. If you have some need that the current version of the framework does not catter for, please help us help you.

Please go to our Issue Tracker on Github and register a ticket with your needs. Don’t forget to provide as much detail as you can. Not only that helps when we implement it, but it helps others to understand your need and identify if they have a similar one, thus enhancing the chance that people will vote for your ticket.

Reporting bugs

Please report bugs using our Issue Tracker on Github and we will review them as soon as possible. Don’t forget to provide as much detail as you can!

Contributing

If you feel comfortable with Python and want to contribute with new features or bug fixes, please go ahead and fork our Github repository, do whatever you need to do and request pull. If you don’t know how to do it, please check Github documentation on how to fork projects.

Just remember a few simple things when you’re developing your contribution:

  • Please try to explain what you are doing and the purpose – it will help us improve the documentation and understand your context;
  • Please run all tests before requesting pull – you will not want to break things that were already working;
  • Needless to say :) remember to implement tests for your new features;
  • Be patient :) we try to integrate contributions very quickly but sometimes it may take a few days.

If you want to contribute with extensions and other things that does not make sense to be in the core repository, please fork the pyccuracy-contrib repository