Skip to content
Snippets Groups Projects
Select Git revision
  • patch-12
  • patch-11
  • patch-10
  • patch-9
  • patch-8
  • patch-7
  • patch-6
  • patch-5
  • patch-4
  • patch-3
  • master default protected
  • overview-page-for-handling-data
  • submitting-jobs-overview
  • 28-overview-page-for-connecting-2
  • RDPv10
  • 26-add-screenshots-for-newer-rdp-v10-client
  • patch-2
  • patch-1
  • gpu_update
  • runTime
20 results

CONTRIBUTING.md

Blame
    • Forked from Holland Computing Center / HCC docs
    596 commits behind the upstream repository.
    After you've reviewed these contribution guidelines, you'll be all set to contribute to this project.
    CONTRIBUTING.md 3.31 KiB

    Contributing

    Our users have a wonderful perspective into our documentation that our staff do not. It's easy for people who have been using it for a while to forget how impenetrable some of this material can be. As such, we greatly welcome feedback and contributions of all kinds: suggested changes, fixes to existing material, and bug reports are all welcome.

    Contributor Agreement

    By contributing, you agree that we may redistribute your work under our license.

    How to Contribute a Fix or Suggested Change

    The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording, or a factual error.

    1. If you do not have access to UNL's GitLab instance, you can send us comments by email. However, we will be able to respond more quickly if you use one of the other methods described below.

    2. If you have access to UNL's GitLab instance, but do not know how to use Git, you can report problems or suggest improvements by creating an issue. This allows us to assign the item to someone and to respond to it in a threaded discussion. Detailed information on creating issues can be found in the GitLab Documentation

    3. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are included below.

    Where to Contribute

    1. Checking for outstanding issues is a quick way to identify contribution areas. Additionally, review an comments on existing merge requests are welcome.

    2. All documentation content can be found within the content folder. Subdirectories indicate menu items, with the top level document called _index.md within each subdirectory.

    Note: please do not submit modifications to theme or CSS items, _header or _footer files unless they adhere to UNL style guidelines.

    What to Contribute

    There are many ways to contribute, from contributing additional documentation topics or submitting software specific job examples, to updating or adding to existing documentation and submitting bug reports about things that don't work, aren't clear, or are missing.

    Comments on issues and reviews of pull requests are just as welcome: we are smarter together than we are on our own. Reviews from novices and newcomers are particularly valuable: so fresh eyes are always welcome.

    Using GitLab

    The best way to submit proposed changes is:

    1. Create a fork of the HCC docs repository.
    2. Clone your forked repository and commit changes.
    3. Submit a merge request between your fork and the main HCC docs repository.

    Other Resources

    If you have any questions or feedback, please contact us at hcc-support@unl.edu.