From b0fd23dcfc80b60e6b88bf0a26ccbb92794b6f9d Mon Sep 17 00:00:00 2001 From: es183923 <72744903+es183923@users.noreply.github.com> Date: Tue, 30 Aug 2022 13:28:40 -0400 Subject: [PATCH] docs(contributing): explain emoji usage Co-authored-by: winston --- docs/contributing.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/contributing.md b/docs/contributing.md index a7e143e..5ffcb0c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -55,7 +55,9 @@ Although you just created the repo successfully, it's important to style it prop - The name of the repo must be the simplest version of the app's name (e.g `nvim` instead of `NeoVim`). You may use hyphens if needed (e.g. `windows-files`). - Put the images under `assets/`. If there are a bunch of them consider [creating an empty branch](https://gist.github.com/joncardasis/e6494afd538a400722545163eb2e1fa5) (e.g. `assets`) and storing them there. -- Format the repo's description as "`` "Soothing pastel theme for App" +- Format the repo's description as "`` Soothing pastel theme for ``". + - `` should be an emoji that you feel represents the app best. + - `` is the name of the app, capitalized properly. - Add `catppuccin` to the topics. - Ensure uppercase meta files (e.g. `README.md`) - Don't add health files (e.g. `CODE_OF_CONDUCTS.md`, `SUPPORT.md`), those are organization-wide files stored [here](https://github.com/catppuccin/.github).