We would love to have your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug (make a github issue)
- Discussing the current state of the code
- Submitting a fix (fork and pull as explained below)
- Proposing new features (mention it on github or make a github issue)
Make sure to join our discord for any discussion or questions related to the project.
Don't forget to discuss any changes before making them to avoid extra work!
- Fork the repository
- Make some changes
- If you change the API, update documentation
- Make sure your code lints
- Issue that pull request!
We use the airbnb style on The Slothpixel Project.
Run npm run lint
to automatically fix the style, or use
npm run lintnofix
to see a list of inconsistencies.
- camelCase is used in file and variable naming
- indentation is done with 2 spaces
- single quotes should be used