CONTRIBUTING.rst 3.71 KB

Contribution Guide for Feedback Reporter

Author:
  • A. Wilcox, documentation writer
Status: Draft
Copyright: © 2017 Adélie Linux Team. NCSA open source licence.

Introduction

This repository contains code and documentation for the Adélie Linux Feedback Reporter, a small Qt5-based utility designed to allow users easily report issues or comments about the current operating environment.

License

As the Adélie Linux project is an open-source Linux distribution, this package is distributed under the same NCSA open source license as the distribution.

Changes

If you have an improvement or fix for feedback-reporter, please send it to the appropriate Adélie Linux mailing list or open a pull request on our GitLab.

For more information on contributing your changes, see the Contributing Changes section of this document.

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 equivalent to 8 columns. 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.

"Allman-style" brace patterns are used for most code, as follows:

`` if(condition) {

// branch code

} else {

// other branch code

}

Testing

You must test any changes on Adélie Linux. It is recommended that you additionally test your changes on at least a glibc-based Linux distribution.

You are additionally welcome to test on BSD, Mac OS X, Solaris, AIX, or other operating envrionments.

Contributing Changes

This section describes the usual flows of contribution to this repository.

GitLab Pull Requests

  1. If you do not already have a GitLab account, you must create one.
  2. Create a fork of the packages repository. For more information, consult the GitLab online documentation.
  3. Clone your forked repository to your computer.
  4. Make your changes.
  5. Test your changes to ensure they are correct.
  6. Add (or remove) changed files using git add and git rm.
  7. Commit your changes to the tree using the command git commit and git push.
  8. Visit your forked repository in a Web browser.
  9. Choose the Create Pull Request button.
  10. Review your changes to ensure they are correct, and then submit the form.

Mailing List

  1. Clone the packages repository to your computer.

  2. Make your changes.

  3. Test your changes to ensure they are correct.

  4. Add (or remove) changed files using git add and git rm.

  5. Commit your changes to the tree using the command git commit.

  6. 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^^^.

  7. Email the resulting patch to the packagers mailing list.