Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.45 KB
Raw

Contributing

Contributions to Verlite are welcome—both PRs and issues—and are much apricated.

Found an issue?

If there is no already existing issue, open a new one using the appropriate issue template. Please include as much relevant information as possible, including a minimal snippet that reproduces the bug.

Have a question?

Head over to the discussion tab! Please avoid opening an issue for a question.

Pull request do's and don'ts

Please do:

  • Do follow the coding style as defined in the .editorconfig.
  • Do include tests when adding new features and cover all new lines.
  • Do write a failing unit test for bug fixes prior to the fixing commit.

Please do not:

  • Don't include breaking changes without prior discussion. SemVer major bump
  • Don't add to the public API without a proposal.
  • Don't make large changes without prior discussion to avoid wasted time.
  • Don't commit code you didn't write, unless under an MIT compatible permissive and attribution is included.
  • Don't make PRs for style changes. Ruby on Rails explanation

Commit Messages

Please link relevant issues in the footer.

For trivial changes, a short but descriptive summary is acceptable.

For non trivial changes, please include a short summary and a body, following the format specified here: A Note About Git Commit Messages.