Thank you for expressing your interest in contributing to Chocomint !
Chocomint is an open-source project. If you want to contribute to the project, this section is here to guide you through your first steps with the Chocomint team 🌿
Before starting any development, we highly encourage you to submit an issue on Github in order to discuss the problem, and the solution with the team. If you want to reach out to the dev team directly, contact support in discord.
Make sure you have the latest version of the default branch ( develop or main )
$ git checkout develop
$ git pull upstream develop
Create your own branch and install dependencies
$ git checkout -b branch-name
Happy coding 🎉
We try to maintain as much consistency as we can between each of our repository. Your pull request has more chances to be accepted if you follow the following rules and write high quality code. Let's get started 💪
Use the UIKit
Check the UI Kit before you start doing anything. A lot of components are already created, and we don't want that you waste your time reinventing the wheel 😉
If a variant of a component needs to be created, use the corresponding component in the UI Kit as a base. For example:
Your code is ready to be submitted for review, congratulations🥳
All pull requests must have a description of what the PR is trying to accomplish.
Keep pull requests as small as possible. Larger pull requests should be broken up into smaller chunks with a dedicated base branch. Please tag the PR's that are merging into your base branch with the epic tag.
If possible self-review your PR and add comments where additional clarification is needed.
Create a draft PR as soon as possible so we can view your ongoing progress.
Thank you for helping us making Chocomint even more awesome ❤