Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 1.93 KB

CONTRIBUTING.md

File metadata and controls

42 lines (26 loc) · 1.93 KB
Raw

How to contribute to Pupilfirst

Did you find a bug?

  • Do not open up a GitHub issue if the bug is a security vulnerability in Pupilfirst. Instead, please send our development team an email detailing the security issue. Please check the security policy for more details.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, and as much relevant information as possible.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Make sure that the Allow edits from maintainers option is enabled. This will allow us to quickly patch your PR if we want to merge it.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Before submitting, please make sure that your code is properly formatted. For Ruby code, that usually means following the settings in .editorconfig and making sure that Rubocop doesn't complain. For ReasonML, it's simpler - just make sure that your development environment is set up correctly so that refmt auto-formats code.

Do you intend to add a new feature or change an existing one?

  • Suggest your change in the issues list, so that it can be discussed.

  • If you wish to start writing code, please make sure that you get the go-ahead from someone on the Pupilfirst team.

Do you have questions about the source code?

Send the developer group an email!

Thank you for your interest!

Pupilfirst Team