Skip to content

Latest commit

 

History

History
31 lines (20 loc) · 1.65 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 1.65 KB
Raw

Contributing

Welcome to lrud-spatial, a spatial navigation library for devices with input via directional controls. Thanks for your interest in contributing.

Here's how to get involved...

Reporting Issues

Before opening a new issue, first check that there is not already an open issue or Pull Request that addresses it.

If there is, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

  1. Pick an appropriate template for the type of issue from here
  2. Provide as much detail as possible
  3. Follow your issue in the issue tracking workflow

Contributing Code

For significant feature changes, be sure to open an issue with the feature-request template first to gather feedback from the package maintainers.

BBC staff may have push access to the repository, in which case you may clone this repository and create a working branch with a kebab-case name reflecting what you are working on (e.g. fix-the-thing). Otherwise please fork it. You should then work on your own master branch.

Follow the setup instructions in the README.

Ensure all your code is thoroughly tested and that this testing is detailed in the pull request.

Pull Request Process

  1. Read and complete all relevant sections of the PR template
  2. The Pull Request can be merged once signed-off by a maintainer