Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (21 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.29 KB
Raw

Contributing

Thanks for wanting to contribute to InputMobile! These are the contribution guidelines to help keep the project organised, consitent and easier to maintain.

Formatting Guidelines

To keep the project consistent, please follow Juju Adams' formatting style, which is the style used in this project.

  • Keep code clean, organised and readable.
  • Use descriptive variable and function names. You should know what they are for just by looking at them.
  • All functions should include proper JSDoc comments with a clear description and explicit type annotations for parameters.

Pull Requests

Before submitting a pull request:

  • Make sure a corresponding issue already exists for the bug or feature you are addressing. If there is no issue, please create one first.
  • Link to the relevant issue in your pull request description.

Branching

Please target the appropriate branch:

  • New features: target the dev branch.
  • Bug fixes: target the relevant maintenance branch (e.g dev-vX.X).
  • Documentation: target the docs branch.

Pull Request Guidelines

  • Use descriptive titles.
  • Provide a detailed description.
  • Include context where necessary.
  • Keep changes focussed and avoid unreleated modifications in one pull request.