Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 1.94 KB

How to contribute

Bugs and suggestions

Projects

All discussions regarding Farseer-NMR major developments, bug reporting and triage and general discussions are registered in our projects page, feel free to browse them. How do we organize our projects? Opened issues are catalogued in projects and consequently closed if an inmediate action is not expected, they are then reopened once under development. Project's "Done" columns identify finished tasks.

Guide to Developers

Please read our Guide to Developers, where you will find information regarding Coding Style and detailed documenation on the Farseer-NMR architecture.

Pull Request

  • Always submit a Pull Request from a cloned or forked repository of Farseer-NMR.
  • Pull Requests title should start with a proposal of version change and, if helpful, followed by a short title: v1.3.12 - corrected bar color bug in barplot
    • follow versioning standards: [major/visible [ new feature [ bug correction]]
    • new version number should be updated in install/system.py.
    • be nice and update the installation banner at install/messages.py using this ASCII text generator, just change the version number in the following link :-):
                                                                                    here
                                                                                    |||||
http://patorjk.com/software/taag/#p=display&h=1&f=Doom&t=---------%0AFarSeer-NMR%0Av1.3.0%0A---------
  • Pull Request description should state the added improvements and corrections.
  • Pull Request should close issues whenever applicable.

Thanks!