summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorA. Wilcox <AWilcox@Wilcox-Tech.com>2017-06-14 20:18:47 -0500
committerA. Wilcox <AWilcox@Wilcox-Tech.com>2017-06-14 20:18:47 -0500
commit0eefd733ef6b4f36b78c60de72827c9ab7c6c29a (patch)
tree7efc973dfca23c60f49f204e51d7dbd03beaa53c
parent0eea43494add09f1ea2ecda0e6892298c9070630 (diff)
downloadgcompat-0eefd733ef6b4f36b78c60de72827c9ab7c6c29a.tar.gz
gcompat-0eefd733ef6b4f36b78c60de72827c9ab7c6c29a.tar.bz2
gcompat-0eefd733ef6b4f36b78c60de72827c9ab7c6c29a.tar.xz
gcompat-0eefd733ef6b4f36b78c60de72827c9ab7c6c29a.zip
Since we have readme, add CONTRIBUTING and LICENSE too
-rw-r--r--CONTRIBUTING.rst112
-rw-r--r--LICENSE32
2 files changed, 144 insertions, 0 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..4d48bfd
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,112 @@
+===================================
+ Contribution Guide for libgcompat
+===================================
+:Author:
+ * **A. Wilcox**, documentation writer
+:Copyright:
+ © 2016-2017 Adélie Linux and contributors. NCSA open source licence.
+
+
+
+
+Introduction
+============
+
+This repository contains the libgcompat, a library providing GNU libc (glibc)
+compatibility for Linux computers using the musl libc.
+
+
+
+
+Code style
+==========
+
+Contributions are expected to maintain a consistent code style. This ensures
+readable and future maintainability, since all the code will look and feel the
+same. A few key notes about the C style used in this repository:
+
+
+Include comments
+````````````````
+
+When using the ``#include`` preprocessor directive, add a comment next to it
+detailing the interfaces used from that header. For example:
+
+```
+#include <stdlib.h> // getenv
+```
+
+
+Tabs
+````
+
+Hard tabs (\t) are used, and are 8 spaces. Where brace alignment is required,
+tabs are used to the nearest eighth space, followed by the requisite number of
+spaces.
+
+
+Braces
+``````
+
+**Always** use braces for blocks like ``if``, ``while``, ``for``, even if the
+block only contains a single statement. This is to ensure that more complex
+decision trees do not have accidental side-effects.
+
+
+
+
+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 adelie-dev@lists.adelielinux.org mailing
+ list, or use ``git send-email``.
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..f6fc7a1
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,32 @@
+Copyright (c) 2016-2017 Adélie Linux and its contributors.
+All rights reserved.
+
+Developed by: Adélie Linux and its contributors
+ http://adelielinux.org/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal with the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject
+to the following conditions:
+
+Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimers.
+
+Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimers in
+the documentation and/or other materials provided with the distribution.
+
+Neither the names of Adélie Linux, nor the names of its contributors, may
+be used to endorse or promote products derived from this Software without
+specific prior written permission.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE
+FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE.