🎉 First of all thank you for taking the time to contribute 🎉
Did you run into a issue? please consider the following before creating a issue. This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check if there is not already a issue for your bug, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
When dealing with a security issue please disclose it privately with the head maintainer. You can do this through DM on twitter @niceyannick.
The title of the pull request should describe the changes that you made.
Don't inlcude issue numbers in the pull request title.
A pull requests should follow our style guide and should not break existing functionality.
A pull request has to be approved by a maintainer before being able to be merged.
Everybody is free to review pull requests, and also are encoureged to do so.
While reviewing a pull request please follow or style guide, don't enforce personal style believes.
If you run in to a issue with the review please mark the issue at the line and leave a comment on what needs change.
When reviewing a pull request you should always follow our code of conduct.
Use the present tense ("Add feature" not "Added feature")
Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
Limit the first line to 72 characters or less
Reference issues and pull requests liberally after the first line
When only changing documentation, include [ci skip] in the commit title
Consider starting the commit message with an applicable emoji:
🎨 : art : when improving the format/structure of the code
🐎 : racehorse : when improving performance
🚱 : non-potable_water : when plugging memory leaks
📝 : memo : when writing docs
🐛 : bug : when fixing a bug
🔥 :fire : when removing code or files
✨ : sparkles : when adding new features
💚 : green_heart : when fixing the CI build
✅ : white_check_mark : when adding tests
🔒 : lock : when dealing with security