mirror of
https://github.com/catppuccin/catppuccin
synced 2024-11-22 03:23:04 +00:00
feat: contributing and updated readme
This commit is contained in:
parent
db3e6a4d0c
commit
8e05f405c1
3 changed files with 41 additions and 1 deletions
24
CONTRIBUTING.md
Normal file
24
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Contributing!
|
||||
|
||||
🎉 First off, thanks for taking the time to contribute! 🎉
|
||||
|
||||
## Guidelines
|
||||
|
||||
The following is a set of guidelines for contributing to this project. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||||
|
||||
- PRs should go to the `dev` branch. Reasons:
|
||||
- If there is already stuff under development, then it's likely that a conflict may occur.
|
||||
- Releases/Deployment.
|
||||
- Documentation tends not to be updated by PRs.
|
||||
- Testing.
|
||||
- Use the `.editorconfig` file (located at the root of this project) on your editor so as to "maintain consistent coding styles". For instructions on how to use this file refer to [EditorConfig's website](https://editorconfig.org/).
|
||||
|
||||
## Recommendations
|
||||
|
||||
- Create a topic branch on your fork for your specific PR.
|
||||
- Consider using [conventionalcommits.org's](https://www.conventionalcommits.org/en/v1.0.0/) rules for creating explicit and meaningful commit messages.
|
||||
- If it's your first time contributing to a project then read [About pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) on Github's docs.
|
||||
|
||||
## License
|
||||
|
||||
Any contribution will be published under the same licensing terms as the project itself.
|
18
README.md
18
README.md
|
@ -37,7 +37,23 @@
|
|||
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/circles/png/catppuccin_14.png" height="23" width="23"/> | `#84A5CB` | `132, 165, 203` | `212, 41%, 66%` | `35%, 19%, 0%, 20%` |
|
||||
| <img src="https://raw.githubusercontent.com/catppuccin/catppuccin/dev/assets/circles/png/catppuccin_15.png" height="23" width="23"/> | `#B9C4E3` | `185, 196, 227` | `224, 43%, 81%` | `19%, 14%, 0%, 11%` |
|
||||
|
||||
## Gratitude
|
||||
# 👐 Contribute
|
||||
|
||||
See [CONTRIBUTING.md](https://github.com/catppuccin/catppuccin/blob/dev/CONTRIBUTING.md).
|
||||
|
||||
|
||||
# 📜 License
|
||||
|
||||
Catppuccin is released under the MIT license, which grants the following permissions:
|
||||
|
||||
- Commercial use
|
||||
- Distribution
|
||||
- Modification
|
||||
- Private use
|
||||
|
||||
For more convoluted language, see the [LICENSE file](https://github.com/catppuccin/catppuccin/blob/main/LICENSE.md).
|
||||
|
||||
# 🤗 Gratitude
|
||||
|
||||
Thanks to the following tools developing this project is possible:
|
||||
|
||||
|
|
Loading…
Reference in a new issue