CONTRIBUTING.rst 1.86 KB

Contribution Guide for Adélie Linux Documentation

Author:
  • A. Wilcox, documentation writer
Copyright: © 2015-2018 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

  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 documentation mailing list.