Thank you for being here. It is people like you that help shape a better open-source community. 👍🎉
Following this guideline improves communication and organization, which helps save your and other developers' times and effort in future development.
I welcome all contributions from the community. There are many ways to contribute:
- 🎨 Submit PR to fix bugs, enhance/add existing/new features;
- 🚸 Submit bug reports and feature requests;
- 📝 Improve documentation and writing examples.
If you are submitting a 🐛 bug report, please:
- Use a clear and descriptive title. Describe the behavior you observed and the expected behavior;
- Describe the exact steps which reproduce the problem. A minimal reproduction repo is greatly appreciated;
- Include Node version, OS, Browser or other information that may be helpful in the troubleshooting.
Generally, all external pull requests should have references to an issue.
If you are ✨ adding a new feature or ⚡ improving an algorithm, please first create an issue for discussion.
The steps to submit a PR are:
-
Fork this repository to your own GitHub account and then clone it to your local device.
-
Install all dependencies with
yarn install
. -
Make changes and commit (following the commit message guidelines).
-
Make sure your code is linted by running
yarn run lint
, you can also runyarn run prettier
to format your code.
PokeStats.gg
uses styled-components. Please run yarn run lint
and fix any linting warnings and yarn run prettier
to format your code.
- Use the present tense and imperative mood ("Add feature" instead of "Adds feature" or "Added feature");
- Consider starting the commit message with an applicable emoji (ex. gitmoji) for a more beautiful world 🌈.
You can also reach out to me directly here 📥.
❤️ Thank you, Andre