Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 1.51 KB

👐 Contributing

So you want to contribute? Great! Please read the following instructions to avoid any confusion. Working with many people on a single project can be a challenge, it can very painfull for both maintainers and contributors, so we need to set some guidelines to make it smooth.

NB : These guidelines are and will always be up for discussion. Just open a ticket if anything could be improved!

We love your input, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing improvement / new features
  • Becoming a maintainer

Pull Requests

We welcome pull requests to change to the codebase.

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Make your pull request

Contributions are under the GPL-3.0 License

When you submit code changes, your submissions are understood to be under GPL-3.0 License.

Open source guide

You can read it here.

Code Quality

Please try to do the following :

  • Every new piece of code requires tests.
  • Run yarn lint to make sure that your code passes linting.
  • Naming and folder structure is really important. Have a look to the current code and see how it's done 😉
  • Do not reinvent the wheel : if you want to add a library like lodash instead of ramda, open a ticket first so we can discuss it.