CONTRIBUTING.md 3.31 KB
Newer Older
Carrie A Brown's avatar
Carrie A Brown committed
1 2
# Contributing

Carrie A Brown's avatar
Carrie A Brown committed
3 4 5 6
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:
Carrie A Brown's avatar
Carrie A Brown committed
7 8 9 10 11 12 13
suggested changes,
fixes to existing material,
and bug reports are all welcome.

## Contributor Agreement

By contributing,
Adam Caprez's avatar
Adam Caprez committed
14
you agree that we may redistribute your work under [our license](LICENSE).
Carrie A Brown's avatar
Carrie A Brown committed
15 16 17 18 19 20 21 22

## 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.

Adam Caprez's avatar
Adam Caprez committed
23 24
1.  If you do not have access to [UNL's GitLab instance](http://git.unl.edu),
    you can [send us comments by email](mailto:hcc-support@unl.edu).
Carrie A Brown's avatar
Carrie A Brown committed
25 26 27
    However,
    we will be able to respond more quickly if you use one of the other methods described below.

Adam Caprez's avatar
Adam Caprez committed
28
2.  If you have access to [UNL's GitLab instance](http://git.unl.edu),
Carrie A Brown's avatar
Carrie A Brown committed
29
    but do not know how to use Git,
Adam Caprez's avatar
Adam Caprez committed
30
    you can report problems or suggest improvements by [creating an issue](https://git.unl.edu/hcc/hcc-docs/issues/new).
Carrie A Brown's avatar
Carrie A Brown committed
31
    This allows us to assign the item to someone
Carrie A Brown's avatar
Carrie A Brown committed
32 33
    and to respond to it in a threaded discussion. Detailed information on creating 
    issues can be found in the [GitLab Documentation](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html)
Carrie A Brown's avatar
Carrie A Brown committed
34 35 36 37

3.  If you are comfortable with Git,
    and would like to add or change material,
    you can submit a pull request (PR).
Carrie A Brown's avatar
Carrie A Brown committed
38
    Instructions for doing this are [included below](#using-gitlab).
Carrie A Brown's avatar
Carrie A Brown committed
39

Carrie A Brown's avatar
Carrie A Brown committed
40
## Where to Contribute
Carrie A Brown's avatar
Carrie A Brown committed
41

Adam Caprez's avatar
Adam Caprez committed
42
1.  Checking for outstanding [issues](https://git.unl.edu/hcc/hcc-docs/issues) is a quick way to identify contribution areas. Additionally,
Carrie A Brown's avatar
Carrie A Brown committed
43 44 45
    review an comments on existing merge requests are welcome.

2.  All documentation content can be found within the `content` folder. Subdirectories indicate menu items,
Carrie A Brown's avatar
Carrie A Brown committed
46 47
    with the top level document called `_index.md` within each subdirectory.

Carrie A Brown's avatar
Carrie A Brown committed
48
Note: please do not submit modifications to theme or CSS items, `_header` or `_footer` files unless they 
Adam Caprez's avatar
Adam Caprez committed
49
adhere to [UNL style guidelines](https://wdn.unl.edu/unl-web-framework-5-standards-guide).
Carrie A Brown's avatar
Carrie A Brown committed
50 51 52 53

## What to Contribute

There are many ways to contribute,
Carrie A Brown's avatar
Carrie A Brown committed
54
from contributing additional documentation topics or submitting software specific job examples, 
Adam Caprez's avatar
Adam Caprez committed
55
to updating or adding to existing documentation and submitting [bug reports](https://git.unl.edu/hcc/hcc-docs/issues)
Carrie A Brown's avatar
Carrie A Brown committed
56 57 58 59 60 61 62
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.

Carrie A Brown's avatar
Carrie A Brown committed
63
## Using GitLab
Carrie A Brown's avatar
Carrie A Brown committed
64

Carrie A Brown's avatar
Carrie A Brown committed
65 66 67 68 69 70 71
The best way to submit proposed changes is:
1. Create a fork of the HCC docs repository.
    - [Documentation on how to fork a project](https://docs.gitlab.com/ee/gitlab-basics/fork-project.html)
2. Clone your forked repository and commit changes.
    - [Details on setting up a Hugo environment on your personal machine](README.md)
3. Submit a merge request between your fork and the main HCC docs repository.
    - [How to submit a merge request](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html)
Carrie A Brown's avatar
Carrie A Brown committed
72 73 74

## Other Resources

Carrie A Brown's avatar
Carrie A Brown committed
75
If you have any questions or feedback, please contact us at hcc-support@unl.edu.