diff options
author | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2019-10-13 05:29:54 -0500 |
---|---|---|
committer | A. Wilcox <AWilcox@Wilcox-Tech.com> | 2019-10-13 05:29:54 -0500 |
commit | 56bf0e8d486828584596c6c28274b5d7608b6456 (patch) | |
tree | e61cc569247ffa24233ab28d85bd61b580dda75e /CONTRIBUTING.rst | |
parent | 536da1a3b146037c0f34fb7a767020538bdcc44d (diff) | |
download | horizon-56bf0e8d486828584596c6c28274b5d7608b6456.tar.gz horizon-56bf0e8d486828584596c6c28274b5d7608b6456.tar.bz2 horizon-56bf0e8d486828584596c6c28274b5d7608b6456.tar.xz horizon-56bf0e8d486828584596c6c28274b5d7608b6456.zip |
docs: Fix up nicely
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..974be6a --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,72 @@ +======================================== + Contribution Guide for Project Horizon +======================================== +:Author: + * **A. Wilcox**, documentation writer +:Copyright: + © 2015-2019 Adélie Linux Team. NCSA open source licence. + + + + +Contributing Changes +==================== + +This section describes the usual flows of contribution to this repository. +For a detailed description of how to contribute to Adélie Linux, review the +Handbook_. + +.. _Handbook: https://help.adelielinux.org/html/devel/ + + +GitLab Pull Requests +```````````````````` + +#. If you do not already have a GitLab account, you must create one. + +#. Create a *fork* of the Horizon 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 commands ``git commit -S`` 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 Horizon 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 -S``. + +#. 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 mailing list, using ``git send-email`` or + your mail client. Ensure you are subscribed_ first. + +.. _subscribed: https://lists.adelielinux.org/postorius/lists/horizon.lists.adelielinux.org/ |