We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
We use github to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow, So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've changed needs, update the documentation.
- Make sure your code lints. (yarn lint)
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github's issues
We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing, you agree that your contributions will be licensed under its MIT License.
When you add a feature like a new component or template, check the following rules before push the PR :
item=components/templates
- A similar item does not already exist
- My item is in the right category
- The sitemap.xml is up to date (with new section added)
- My item is logically grouped below similar items
- The content of my item is realistic (avoid lorem ipsum)
- All images use in my item are serve locally and as light as possible (use next/image for optimization )
- If possible, provide a dark implementation of the item
- I have read and followed the contribution guidelines