From faf0c25b90cf3b7b2f8ce0ec4ed0a73b28cf7bfa Mon Sep 17 00:00:00 2001 From: Alexandr Garbuzov Date: Sun, 11 Jun 2023 16:21:58 +0300 Subject: [PATCH] Update automated themes preview workflow contributions guideline (#2808) * Update automated themes preview workflow contributions guideline * docs: link to top-issues dashboard --------- Co-authored-by: rickstaa --- CONTRIBUTING.md | 2 +- scripts/preview-theme.js | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4873bdbcf5f69..e2091c0baf850 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,7 @@ All you need to do is edit the [themes/index.js](./themes/index.js) file and add > If you are contributing your theme just because you are using it personally, then you can [customize the looks](./readme.md#customization) of your card with URL params instead. > **Note** -> Keep in mind that we already have a wide collection of different themes, in order not to inflate their number, we began to add only themes that were supported by the community. It means that your pull request with theme addition will not be merged until we get enough positive feedback from the community in the form of comments, thumb up and heart emojis. Remember that you are also able to support themes of other contributors that you liked to speed up their merge. +> Keep in mind that we already have a vast collection of different themes. To keep their number manageable, we began to add only themes supported by the community. Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935#top-themes-prs). Remember that you can also support themes of other contributors that you liked to speed up their merge. ## Any contributions you make will be under the MIT Software License diff --git a/scripts/preview-theme.js b/scripts/preview-theme.js index 57b792a369c95..44a05d77f62e4 100644 --- a/scripts/preview-theme.js +++ b/scripts/preview-theme.js @@ -28,8 +28,11 @@ const FAIL_TEXT = ` `; const THEME_CONTRIB_GUIDELINES = ` \rHi, thanks for the theme contribution. Please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution). - \rWe are currently only accepting color combinations from any VSCode theme or themes with good color combinations to minimize bloating the themes collection. + \r> **Warning** + \r> Keep in mind that we already have a vast collection of different themes. To keep their number manageable, we began to add only themes supported by the community. Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935#top-themes-prs). Remember that you can also support themes of other contributors that you liked to speed up their merge. + + \r> **Note** \r> Also, note that if this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card [customization options](https://github.com/anuraghazra/github-readme-stats#customization). `; const COLOR_PROPS = {