Skip to content

Latest commit

 

History

History
44 lines (26 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

44 lines (26 loc) · 2.16 KB

First of all, thank you for wanting to contribute, it helps make this project even better, below is a guide to contributing.

How to contribute

We follow a simple fork and pull request based contribution system.

We will only accept a single feature per pull request.

To contribute:

  • Come up with a change you wish to make.
  • Fork our project.
  • Add your new feature.
  • Create a pull request.

If you need further guidance, you can find our team on the following platforms:

Please note we have a code of conduct, please follow it in all your interactions with the project.

Getting started

Here you should address guidelines about future functionalities, milestone labels, bugs and unlisted features, issued assignments, etc. Since now we have an Issue and a Pull Request template, you can reference them directly:

For further guidance about getting started, please refer to the related links:

Coding conventions

We follow some fairly different coding styles, please make sure your IDE/Code editor has an installed eslint plugin that uses our eslint file.

Additionally some differences between our code and most common projects:

  • We use tabs over spaces, this is because tabs are controllable sizing and helps with people who have issues with vision. More Info
  • We use tsdoc to help make our code easier to read, alongside offer help to editors for hinting.
  • We like to use comments, the general rule is, if something is not obvious comment the nearest block, i.e. if you have 4 lines of code that do something, comment it, makes it easier to come back to.

Code of Conduct

See our Code of Conduct.