From efc6792152a1b5fba1165a0ff41ccf74541ca134 Mon Sep 17 00:00:00 2001
From: "A. Wilcox" <AWilcox@Wilcox-Tech.com>
Date: Wed, 6 Mar 2019 19:09:04 -0600
Subject: Add documentation for the repository

---
 CONTRIBUTING.rst | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 100 insertions(+)
 create mode 100644 CONTRIBUTING.rst

(limited to 'CONTRIBUTING.rst')

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..d9ab608
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,100 @@
+====================================================
+ Contribution Guide for Adélie Linux Build Software
+====================================================
+:Author:
+  * **A. Wilcox**, documentation writer
+:Status:
+  Production
+:Copyright:
+  © 2019 Adélie Linux Team.  NCSA open source licence.
+
+
+
+
+Introduction
+============
+
+This repository contains the software used to build the Adélie Linux package
+set.  It is used by Adélie Linux for package building to create the repository
+used by Adélie's APK package manager.
+
+
+Changes
+```````
+Any changes to this repository - additions, removal, or version bumps - must
+be reviewed before being pushed to the master branch.  There are no exceptions
+to this rule.  For security-sensitive updates, contact the Security Team at
+sec-bugs@adelielinux.org.
+
+
+
+
+Source Code Format
+==================
+
+Shell scripts must be as close to POSIX Shell as possible.  Bash extensions
+are explicitly not allowed.
+
+
+
+
+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 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 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 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 -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.  The mailing list is adelie-devel, on the
+   lists.adelielinux.org mailman server.
-- 
cgit v1.2.3-70-g09d2