If you're reading this, you're definitely awesome!
The following is a set of guidelines for contributing to Sonnat-UI and its packages, which are hosted in the Sonnat-UI's GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the Sonnat Code of Conduct. By participating, you are expected to uphold this code.
There are many ways to contribute to Sonnat-UI, code contribution is one aspect of it. For instance, documentation improvements are as important as code changes.
Working on your first Pull Request? You can learn how from this free video series:
How to Contribute to an Open Source Project on GitHub
To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain changes that have a relatively limited scope. This label means that there is already a working solution to the issue in the discussion section. Therefore, it is a great place to get started.
We also have a list of good to take issues. This label is set when there has been already some discussion about the solution and it is clear in which direction to go. These issues are good for developers that want to reduce the chance of going down a rabbit hole.
You can also work on any other issue you choose to. The "good first" and "good to take" issues are just issues where we have a clear picture about scope and timeline. Pull requests working on other issues or completely new problems may take a bit longer to review when they don't fit into our current development cycle.
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you have started to work on it so other people don't accidentally duplicate your effort.
If somebody claims an issue but doesn't follow up for more than a week, it's fine to take it over but you should still leave a comment. If there has been no activity on the issue for 7 to 14 days, it is safe to assume that nobody is working on it.
Sonnat-UI is a community project, so Pull Requests are always welcome, but, before working on a large change, it is best to open an issue first to discuss it with the maintainers.
When in doubt, keep your Pull Requests small. To give a Pull Request the best chance of getting accepted, don't bundle more than one feature or bug fix per Pull Request. It's often best to create two smaller Pull Requests than one big one.
-
Fork the repository.
-
Clone the fork to your local machine and add upstream remote:
git clone https://github.com/<your username>/sonnat-ui.git
cd sonnat-ui
git remote add upstream https://github.com/sonnat/sonnat-ui.git- Synchronize your local
nextbranch with the upstream one:
git checkout next
git pull upstream next- Install the dependencies with yarn (npm isn't supported):
yarn install- Create a new topic branch:
git checkout -b my-topic-branch- Make changes, commit and push to your fork:
git push -u origin HEAD- Go to the repository and make a Pull Request.
The core team is monitoring for Pull Requests. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.
Please follow the coding style of the project. Sonnat-UI uses prettier and eslint, so if possible, enable linting in your editor to get real-time feedback.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- 🎨 [:art:] when improving the format/structure of the code
- 🐎 [:zap:] when improving performance
- 🚱 [:non-potable_water:] when plugging memory leaks
- 📝 [:memo:] when writing/updating api docs
- 🐛 [:bug:] when fixing a bug
- 🚑️ [:ambulance:] when hotfixing a critical bug
- ✨ [:sparkles:] when introducing new features
- ⭐️ [:star:] when adding new components
- 🔥 [:fire:] when removing code or files
- 🔖 [:bookmark:] when adding version tags
- 🚨 [:rotating_light:] when fixing compiler/linter warnings
- 🚧 [:construction:] when the work is in progress
- ♻️ [:recycle:] when refactoring code
- 🔧 [:recycle:] when adding/updating configuration files
- 🔨 [:hammer:] when adding/updating development scripts
- ✏️ [:pencil2:] when fixing a typo
- 💩 [:poop:] when writing a bad code that needs to be improved
- 👽️ [:alien:] when updating code due to external API changes
- 🚚 [:truck:] when moving/renaming resources
- 💥 [:boom:] when introducing breaking changes
- 🍱 [:bento:] when adding/updating assets
- ♿️ [:wheelchair:] when improving accessibility
- 🚸 [:children_crossing:] when improving UX
- 💄 [:lipstick:] when improving UI
- ⚰️ [:coffin:] when removing dead code
- 🗑️ [:wastebasket:] when deprecating code🤺
- 💚 [:green_heart:] when fixing the CI build
- ✅ [:white_check_mark:] when adding tests
- 🔒 [:lock:] when dealing with security
- ⬆️ [:arrow_up:] when upgrading dependencies
- ⬇️ [:arrow_down:] when downgrading dependencies
By contributing your code to the sonnat/sonnat-ui GitHub repository, you agree to license your contribution under the MIT license.