First of all, thank you for taking the time to contribute to this project! 🤗
Read our Code of Conduct to understand which actions are and aren’t tolerated.
Don't forget to drop a star ⭐ on the project if you like it! ✨
Issues can be used to report bugs, typos, request features, or ask questions.
Before opening an issue, please check to make sure someone hasn't already opened an issue about it.
Before you start working on an issue, please comment on the issue and wait for it to be assigned to you. This is to avoid multiple people working on the same issue.
Once you have been assigned an issue, you can start working on it. When you are ready to submit your changes, open a pull request. For a detailed pull request tutorial, see this guide.
Please make sure your Pull Request adheres to the following guidelines:
- Use the PR template provided.
- Keep your Pull Request title succinct, detailed and to the point.
- Keep commits atomic. One commit should contain one change. If you want to make multiple changes, submit multiple Pull Requests.
- Commits should be clear, concise and easy to understand.
- References to the Issue number in the Pull Request and/or Commit message.
- Add the new word in the file:
src/data/words.ts, keeping alphabetical order. - Add the word's phrase and translation to pt-BR in
src/data/contents.ts. - Add the word's image in
public/images/[initial_letter]/[word].png| make sure the image format ispng.
Please keep the alphabetical order in both files, it helps with organization.
Ensure that the image makes sense with the sentence and vice versa.
🎉 Congratulations 🎉
Thanks for taking the time and effort to contribute to this project! ✨
We are excited to see your code in this project! ⭐
By contributing to this project, you agree that your contributions will be licensed under its MIT License.