You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please start by creating an issue to describe the problem or the feature you would like.
11
+
This allows for discussion to happen which may resolve the issue at that stage, or perhaps clarify the request and the work to be done.
12
+
19
13
There are two types of issues: bugs and feature requests. A bug report is an issue that describes a problem with the
20
14
documentation. A feature request is an issue that describes a new feature that should be added to the documentation.
15
+
21
16
Before creating either make sure to check for duplicates. If you find a duplicate, comment on the issue and add your
22
-
input where possible. If possible we would love to see a PR that fixes the issue. If you are unsure how to fix the issue
17
+
input where possible. If possible we would love to see a pull request that fixes the issue. If you are unsure how to fix the issue
23
18
that is perfectly alright.
24
19
25
20
Bug Reports
@@ -37,11 +32,28 @@ Feature Requests
37
32
* Why you think this feature should be added
38
33
* Screenshots (If applicable)
39
34
35
+
Creating a Pull Request
36
+
-----------------------
37
+
38
+
A Pull Request (PR) is a proposal to merge a set of changes from one branch into another.
39
+
In a pull request, collaborators can review and discuss the proposed set of changes before they integrate the changes into the main codebase.
40
+
In GitHub, a PR will display the differences between the content in the source branch and the content in the target branch.
41
+
42
+
PRs should be made to the `FTC Docs <https://github.com/FIRST-Tech-Challenge/ftcdocs>`_ repository on GitHub. Your
43
+
title should aim to describe the purpose of your PR in a *concise* manner. For more information on creating a PR, see
44
+
`creating a pull request <https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request>`_
45
+
on GitHub.
46
+
We have specific guidance for making changes, start with the :doc:`Change Overview </contrib/tutorials/overview/overview>`.
47
+
40
48
Colophon
41
49
--------
42
50
43
51
FTC Docs is built with `Sphinx <https://www.sphinx-doc.org/>`__ using a `theme <https://github.com/readthedocs/sphinx_rtd_theme>`__ provided by `Read the Docs <https://readthedocs.org/>`__.
44
52
53
+
Sphinx is a documentation generator.
54
+
Sphinx converts reStructuredText files into HTML web pages.
55
+
Read the Docs is a documentation hosting platform and provides the base Sphinx theme for FTC Docs.
56
+
45
57
The `Dark theme <https://github.com/FIRST-Tech-Challenge/ftcdocs-helper/tree/main/sphinx_rtd_dark_mode_v2>`__ is provided by the FTC Docs development team.
46
58
47
59
.. We might wish to state what version of Sphinx we use and other version info.
0 commit comments