diff options
author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2017-09-07 02:45:08 -0500 |
---|---|---|
committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2017-09-07 02:45:08 -0500 |
commit | de0f71a328acc925840ab57856be11f806b2ea49 (patch) | |
tree | 5695e5ac57e1b842854758a25aa6de10284f8330 /CONTRIBUTING.rst | |
download | docs-de0f71a328acc925840ab57856be11f806b2ea49.tar.gz docs-de0f71a328acc925840ab57856be11f806b2ea49.tar.bz2 docs-de0f71a328acc925840ab57856be11f806b2ea49.tar.xz docs-de0f71a328acc925840ab57856be11f806b2ea49.zip |
Initial commit
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r-- | CONTRIBUTING.rst | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..f69a67c --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,72 @@ +=================================================== + Contribution Guide for Adélie Linux Documentation +=================================================== +:Author: + * **A. Wilcox**, documentation writer +:Copyright: + © 2015-2017 Adélie Linux. CC BY-NC-SA open source licence. + + + + +Introduction +============ + +This distribution contains the documentation set for Adélie Linux. + + +Contributing Changes +==================== + +This section describes the usual flows of contribution to this repository. + + +GitLab Pull Requests +```````````````````` + +#. If you do not already have a GitLab account, you must create one. + +#. Create a *fork* of the packages repository. For more information, consult + the GitLab online documentation. + +#. Clone your forked repository to your computer. + +#. Make your changes. + +#. Test your changes to ensure they are correct. + +#. Add (or remove) changed files using ``git add`` and ``git rm``. + +#. Commit your changes to the tree using the command ``git commit`` and + ``git push``. + +#. Visit your forked repository in a Web browser. + +#. Choose the *Create Pull Request* button. + +#. Review your changes to ensure they are correct, and then submit the form. + + +Mailing List +```````````` + +#. Clone the packages repository to your computer. + +#. Make your changes. + +#. Test your changes to ensure they are correct. + +#. Add (or remove) changed files using ``git add`` and ``git rm``. + +#. Commit your changes to the tree using the command ``git commit``. + +#. Use the command ``git format-patch HEAD^`` to create a patch file for your + commit. + + .. note:: If you have made multiple commits to the tree, you will need to + add an additional ^ for each commit you have made. For example, + if you have made three commits, you will use the command + ``git format-patch HEAD^^^``. + +#. Email the resulting patch to the documentation mailing list. + |