mirror of
https://github.com/koloideal/Argenta.git
synced 2026-06-10 10:05:28 +03:00
Update documentation
This commit is contained in:
+21
-21
@@ -18,22 +18,22 @@
|
||||
* Сослаться на проект в `README` вашего репозитория.
|
||||
* Упомянуть проект на митапах и рассказать о нём друзьям и коллегам.
|
||||
|
||||
.. _Содержание:
|
||||
.. _contents:
|
||||
|
||||
Содержание
|
||||
----------
|
||||
|
||||
* `Кодекс поведения`_
|
||||
* `У меня есть вопрос`_
|
||||
* `Я хочу внести вклад`_
|
||||
* `Сообщение об ошибках`_
|
||||
* `Предложение улучшений`_
|
||||
* `Ваш первый вклад в код`_
|
||||
* `Улучшение документации`_
|
||||
* `Руководства по стилю`_
|
||||
* `Присоединяйтесь к команде проекта`_
|
||||
* :ref:`Кодекс поведения <code-of-conduct>`
|
||||
* :ref:`У меня есть вопрос <i-have-a-question>`
|
||||
* :ref:`Я хочу внести вклад <i-want-to-contribute>`
|
||||
* :ref:`Сообщение об ошибках <reporting-bugs>`
|
||||
* :ref:`Предложение улучшений <suggesting-enhancements>`
|
||||
* :ref:`Ваш первый вклад в код <your-first-code-contribution>`
|
||||
* :ref:`Улучшение документации <improving-documentation>`
|
||||
* :ref:`Руководства по стилю <styleguide>`
|
||||
* :ref:`Присоединяйтесь к команде проекта <join-the-project-team>`
|
||||
|
||||
.. _Кодекс поведения:
|
||||
.. _code-of-conduct:
|
||||
|
||||
Кодекс поведения
|
||||
----------------
|
||||
@@ -43,7 +43,7 @@
|
||||
|
||||
-----
|
||||
|
||||
.. _У меня есть вопрос:
|
||||
.. _i-have-a-question:
|
||||
|
||||
У меня есть вопрос
|
||||
------------------
|
||||
@@ -60,7 +60,7 @@
|
||||
|
||||
-----
|
||||
|
||||
.. _Я хочу внести вклад:
|
||||
.. _i-want-to-contribute:
|
||||
|
||||
Я хочу внести вклад
|
||||
-------------------
|
||||
@@ -71,7 +71,7 @@
|
||||
|
||||
Внося вклад в этот проект, вы подтверждаете, что являетесь автором 100% контента, обладаете необходимыми правами на него и соглашаетесь, что он может распространяться под лицензией проекта.
|
||||
|
||||
.. _Сообщение об ошибках:
|
||||
.. _reporting-bugs:
|
||||
|
||||
Сообщение об ошибках
|
||||
--------------------
|
||||
@@ -81,7 +81,7 @@
|
||||
Хороший отчёт об ошибке не должен заставлять других вытягивать из вас дополнительную информацию. Пожалуйста, тщательно всё изучите, соберите информацию и подробно опишите проблему. Это поможет нам исправить её как можно быстрее.
|
||||
|
||||
* Убедитесь, что вы используете последнюю версию.
|
||||
* Убедитесь, что проблема действительно является ошибкой, а не вызвана, например, использованием несовместимых версий окружения. Прочтите `документацию <https://argenta.readthedocs.io>`_ и, если нужна поддержка, загляните в раздел `У меня есть вопрос`_.
|
||||
* Убедитесь, что проблема действительно является ошибкой, а не вызвана, например, использованием несовместимых версий окружения. Прочтите `документацию <https://argenta.readthedocs.io>`_ и, если нужна поддержка, загляните в раздел :ref:`У меня есть вопрос <i-have-a-question>`.
|
||||
* Проверьте, нет ли уже отчёта о вашей ошибке в `трекере <https://github.com/koloideal/Argenta/issues?q=label%3Abug>`_.
|
||||
* Также поищите в интернете (включая `Stack Overflow`), чтобы узнать, обсуждалась ли проблема за пределами `GitHub`.
|
||||
* Соберите информацию об ошибке:
|
||||
@@ -108,11 +108,11 @@
|
||||
|
||||
* Команда проекта присвоит задаче соответствующую метку.
|
||||
* Член команды попытается воспроизвести проблему. Если шагов нет или они не приводят к результату, команда попросит вас предоставить их и пометит задачу как `needs-repro`. Такие задачи не будут рассматриваться до тех пор, пока проблема не будет воспроизведена.
|
||||
* Если проблема будет воспроизведена, она будет помечена как `needs-fix` (и, возможно, другими метками, например `critical`), после чего её сможет взять в работу :ref:`любой желающий <Ваш первый вклад в код>`.
|
||||
* Если проблема будет воспроизведена, она будет помечена как `needs-fix` (и, возможно, другими метками, например `critical`), после чего её сможет взять в работу :ref:`любой желающий <your-first-code-contribution>`.
|
||||
|
||||
-----
|
||||
|
||||
.. _Предложение улучшений:
|
||||
.. _suggesting-enhancements:
|
||||
|
||||
Предложение улучшений
|
||||
---------------------
|
||||
@@ -138,7 +138,7 @@
|
||||
|
||||
-----
|
||||
|
||||
.. _Ваш первый вклад в код:
|
||||
.. _your-first-code-contribution:
|
||||
|
||||
Ваш первый вклад в код
|
||||
-----------------------
|
||||
@@ -198,7 +198,7 @@
|
||||
|
||||
-----
|
||||
|
||||
.. _Улучшение документации:
|
||||
.. _improving-documentation:
|
||||
|
||||
Улучшение документации
|
||||
----------------------
|
||||
@@ -215,7 +215,7 @@
|
||||
|
||||
Для улучшения документации вы можете следовать процессу, похожему на внесение вклада в код:
|
||||
|
||||
#. Убедитесь, что ваше окружение для разработки настроено, как описано в разделе `Ваш первый вклад в код`_.
|
||||
#. Убедитесь, что ваше окружение для разработки настроено, как описано в разделе :ref:`Ваш первый вклад в код <your-first-code-contribution>`.
|
||||
#. Перейдите в директорию с документацией.
|
||||
|
||||
.. code-block:: bash
|
||||
@@ -283,7 +283,7 @@
|
||||
|
||||
-----
|
||||
|
||||
.. _Присоединяйтесь к команде проекта:
|
||||
.. _join-the-project-team:
|
||||
|
||||
Присоединяйтесь к команде проекта
|
||||
---------------------------------
|
||||
|
||||
Reference in New Issue
Block a user