The guidelines here are written to help you have a better contribution experience. So I highly suggest you to resort to this document in any part of your contribution.
Thank you for helping me improve this project 🌱 ❤️
In the interest of fostering an open and welcoming environment, we as contributors pledge to making participation in this project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment include:
- Using welcoming and inclusive language ✅
- Being respectful of differing viewpoints and experiences ✅
- Gracefully accepting constructive criticism ✅
- Focusing on what is best for the community ✅
- Showing empathy towards other community members ✅
Examples of unacceptable behavior by participants include:
- The use of sexualized language or imagery and unwelcome sexual attention or advances ❌
- Trolling, insulting/derogatory comments, and personal or political attacks ❌
- Public or private harassment ❌
- Publishing others' private information, such as a physical or electronic address, without explicit permission ❌
- Other conduct which could reasonably be considered inappropriate in a professional setting ❌
Credit: @jessesquires
Have a question, idea, or a suggestion for the website? Have you noticed a bug or found a way to improve the project?
Before doing anything else, review the existing issues and closed ones to see if anyone else opened an issue for what you have in mind.
- If such an issue is still open, do not open a new issue, read the discussion in the existing one and add your comments if you think it will provide a good perspective on the topic.
- If such an issue is closed, read the discussion and if you think that it is necessary to bring the issue back to life, create a new issue with the label: duplicate.
- If there's not such an issue, create one!
If you're ready to create an issue, here's a checklist for you to follow:
⚠️ Apply the appropriate label for the issueSee the descriptions of the project's labels to pick the perfect one for your issue.
- Write a short descriptive title
- For the description of the issue:
- Summarize the issue in a few sentences.
- If it's about a bug, describe how to reproduce the error step by step. (see example)
- If it's about a new feature, describe the intended flow.
- Include screenshots and recordings.
- Link relevant resources that might be helpful.
- Engage with the other contributors in the comments section to discuss the issue, trying to come up with a solution/design/suggestion.
If you're ready to work on an issue, create pull requests. Here are some of the things to consider before submitting a PR:
- Create pull requests for existing issues. If such an issue does not exists, create an issue first, and then submit a PR.
- If an issue is too broad, submit multiple smaller PRs instead of submitting a one big PR, which is harder to review.
- Add a descriptive title
- Link the issue which this PR is referring to.
- Summarize the problem and the aim of the PR in a few sentences.
- List important changes that took place in the code and what they achieved.
- Include before and after screenshots and recordings if any.
- Add relevant resources that helped you.
Here's an example to refer to.
- Submit your PR to the repo's default branch.
- Wait for reviews.
If you don't have time to open issues or PRs but want to contribute, I'd appreciate if you reviewed existing pull requests by providing constructive feedback with clear reasoning and suggestions.
Consistency is the most important. For a quick code review process, try to follow the existing style, formatting, and naming conventions of the overall project and the file you are modifying so that the code reviewers can focus on functionality and performance rather than style.