Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.48 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.48 KB

Contributing

We are always keen to have new contributions to PyGMI, whether by questions, bug reports, feature requests and new code. Please note the GNU General Public Licence v3.0 will apply to all contributions.

Issues

Questions, bug reports and feature requests can be submitted here. Please first check whether your issue has not already be raised, before adding a new issue.

Contributing New Code

Code contributions are welcome, either addressing a bug or feature request, or adding a new feature. If you contribution is not on the issue tracker, then please open the issue link to that issue in your pull request.

Python code guidelines

PyGMI follows the following coding guidelines:

All code should be tested and linted before submission.

Testing

PyGMI uses pytest. Please run all tests locally before creating a pull request. All tests are located in the test folder and its subfolders.

Pull Requests

Pull request can be done using the standard process.