Skip to content

Latest commit

 

History

History
39 lines (19 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

39 lines (19 loc) · 2.09 KB
Raw

How to contribute

Software bug

  • Check whether the bug has already been reported by searching this repository's issues.

  • If no issue addressing the problem already exists, open a new issue. Include a concise, clear title and a minimal, clear description, as much relevant information as possible, and preferably a minmal reproducible example demonstrating the problem.

  • For additional details please visit the spm1d support page.

Bug fix?

  • First check for existing software bug reports (see above). If none exists then...

  • Open a new GitHub pull request with the bug fix. Ensure that your description clearly describes the problem and the solution. Include relevant issue number(s) if applicable.

Cosmetic fix?

Code changes that are purely cosmetic in nature (e.g. whitespace / tab changes) and do not add anything substantial to the stability, functionality, or testability of Rails should generally be avoided unless the changes substantially improve code readability.

New feature?

  • Suggest your change by posting a comment this repository's issues

  • Do not submit the new feature code until the suggested change has collected positive feedback.

Source code questions?

  • Feel free to ask questions about the source code in this repository's issues. Please follow "Software bug" protocol (above) as closely as possible.

General statistics questions?

  • Please avoid posting statistics / interpretation questions to this repository's issues. Statistics questions should generally posted to other forums like Stack Overflow or Stats @ Stack Exchange.

This repository is a volunteer effort. We encourage all to contribute!

The spm1d Team