Thank you for taking your time to contribute to gatsby. You're awesome! 🎉
Please have a look at the following guidelines on how to create high quality pull requests and bug reports.
I want to make sure that you as a contributor receive the recognition you deserve. Therefore this project follows the All Contributors specification.
To add your name to the list of contributors in the README.md comment on an issue or pull request as follows:
@all-contributors please add <username> for <contributions>
You can find a list of all valid contribution types here. Have a look at the Bot's documentation for more details.
Bug reports, questions and feature requests can be made directly by using GitHub Issues so that everyone can see them.
There is a dedicated channel per project for discussions and extensive new feature requests on my discord server. Frequently asked questions and important details discussed there will be added to the FAQ section in the project's readme for everyone to see. Click the badge below and say hello :)
Found a bug? Create a GitHub issue and add as much details as possible by using the provided template to help me understand and fix the issue as fast as I can.
Do you want to contribute a big new feature or a substantial, possibly breaking change? Use the above linked discord channel to suggest your idea and collect feedback about the change first.
Fixes, documentation and smaller code contributions are also very welcome and can be directly made via GitHub pull requests. Use the provided template and again try to fill out as much as you can so that your hard work can be reviewed and merged as soon as possible.
The repository contains configuration files for eslint and prettier alongside strict typescript settings. Just use them and you're good to go. Below is a list of the most important points.
- Intendation of 4 spaces in all files
- Semicolon at the end of every statement
- Single quotes except JSX/TSX properties with double quotes
- Always insert a trailing comma if possible
- JSX/TSX brackets should be in the same line
- Maximum 120 characters per line
- Typescript with strict mode enabled
- Detailed comments for every class / function / property / parameter using TSDoc notation