From e7d51070079d7c94d5488950ed8b85b4e6b9931a Mon Sep 17 00:00:00 2001 From: Noah Gorny Date: Sun, 13 Dec 2020 23:47:39 +0200 Subject: [PATCH] docs: Improve contributing add-screenshot instructions --- docs/contributing.rst | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 98c37761..655d05bd 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -105,5 +105,14 @@ Themes * When adding a new theme, please include a screenshot and a short description about what makes this theme unique in the Pull Request's description field. Please do not add theme screenshots to the repo itself, as they will add unnecessary bloat to the repo. - The project's docs has a `Themes page `_ where you can add a screenshot if you want (by link). + The project's docs has a `Themes page `_ where you should add a screenshot, see how :ref:`here`. * Ideally, you should add a ``.rst`` file describing the theme and its configuration options to ``docs/themes-list`` folder. + +.. _add_screenshot: + +Adding a Screenshot +------------------- + +In order to add a new screenshot, use the ``gh-pages`` branch. +Add your new screenshot to the ``docs/images`` folder, and open a PR. +In the `Themes page `_, see the other screenshots to know what kind of link you should use.