From 8e05f405c1881178d4cf3a2265b70bd731c85e11 Mon Sep 17 00:00:00 2001 From: Pocco81 Date: Sat, 6 Nov 2021 22:32:08 -0500 Subject: [PATCH] feat: contributing and updated readme --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ LICENSE => LICENSE.md | 0 README.md | 18 +++++++++++++++++- 3 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md rename LICENSE => LICENSE.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..0078e13 --- /dev/null +++ b/CONTRIBUTING.md @@ -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. diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/README.md b/README.md index ad881b5..c6f1b9c 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,23 @@ | | `#84A5CB` | `132, 165, 203` | `212, 41%, 66%` | `35%, 19%, 0%, 20%` | | | `#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: