- Opening a pull request without a description or a proper name is not fun for the reviewer, so try to explain your change as much as possible either by text or a code snippet.
- Adding new dependencies or modifying the
package.jsonwill most likely be not accepted or will be accepted in a long time since adding a new dependency to the codebase can be tricky. - This project uses
npm, so please try to respect the choice and try to use it.
These are the useful scripts that you can use while developing. You can find them in the package.json file. You can run them by using npm run <script_name>.
| Script | Description |
|---|---|
dev |
Start the development environment |
build |
Type check and build the app |
generate:types |
Generate all the types for the project |
Ensure the bug was not already reported by searching on GitHub under Issues. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible demonstrating the expected behavior that is not occurring.
Open a GitHub issue stating your feature request clearly. We can discuss it on the issue thread, then you can implement it! 🎉
Open a new GitHub pull request with the patch.
- Fork the repository
- Modify the code and make your amazing change
- Create your feature branch
git checkout -b feature/<your_feature>
- Add your changes
git add . - Commit your changes (please respect the commit message standards)
git commit -m "feat: added amazing things!" - Push your changes
git push -u origin feature/<your_feature>
- Open a pull request from your branch
- State your change in the title according to the conventional commit guidelines.
- Please respect the pull request template while writing your PR description.
Open source software is beautiful, all of your contributions are much appreciated
Thanks!