Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1.38 KB

Contributing

Thanks for taking the time to contribute!

Table Of Contents

How Can I Contribute?

How Can I Contribute?

Reporting Bugs

Bugs are tracked as GitHub issues.

Explain the problem and include additional details to help reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the steps to reproduce the problem in as many details as possible. Include any information that may help reproduce the problem, like time conditions and board placement.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see and why.

Include details about your configuration and environment:

  • Which Pirarucu version are you using? You can get the exact version by running uci command in the CLI.
  • What's the name and version of the OS you're using?

Pull Requests

Pull Requests are previously discussed as GitHub issues.

  • Ensure that unused dependencies or files are not included.
  • Update the README.md with details of changes.
  • Following SemVer versioning scheme increment the version number in gradle.properties.
  • Follow Kotlin styleguide.
  • Your Pull Request will be merged once it is approved by a reviewer.