Skip to content
Snippets Groups Projects

Contributing

Merged Carrie A Brown requested to merge contributing into master
All threads resolved!
1 file
+ 15
12
Compare changes
  • Side-by-side
  • Inline
+ 15
12
# Contributing
# Contributing
At HCC, we welcome contributions of all kinds:
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,
suggested changes,
fixes to existing material,
fixes to existing material,
and bug reports are all welcome.
and bug reports are all welcome.
@@ -26,7 +29,8 @@ or a factual error.
@@ -26,7 +29,8 @@ or a factual error.
but do not know how to use Git,
but do not know how to use Git,
you can report problems or suggest improvements by [creating an issue][issues].
you can report problems or suggest improvements by [creating an issue][issues].
This allows us to assign the item to someone
This allows us to assign the item to someone
and to respond to it in a threaded discussion.
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)
3. If you are comfortable with Git,
3. If you are comfortable with Git,
and would like to add or change material,
and would like to add or change material,
@@ -48,25 +52,24 @@ or a factual error.
@@ -48,25 +52,24 @@ or a factual error.
## What to Contribute
## What to Contribute
There are many ways to contribute,
There are many ways to contribute,
from writing new exercises and improving existing ones
from contributing additional documentation topics or submitting software specific job examples,
to updating or filling in the documentation
to updating or adding to existing documentation and submitting [bug reports][issues]
and and submitting [bug reports][issues]
about things that don't work, aren't clear, or are missing.
about things that don't work, aren't clear, or are missing.
If you are looking for ideas,
please see [the list of issues for this repository][issues],
or the issues for [Data Carpentry][dc-issues]
and [Software Carpentry][swc-issues] projects.
Comments on issues and reviews of pull requests are just as welcome:
Comments on issues and reviews of pull requests are just as welcome:
we are smarter together than we are on our own.
we are smarter together than we are on our own.
Reviews from novices and newcomers are particularly valuable:
Reviews from novices and newcomers are particularly valuable:
it's easy for people who have been using these lessons for a while
to forget how impenetrable some of this material can be,
so fresh eyes are always welcome.
so fresh eyes are always welcome.
## Using GitLab
## Using GitLab
Include instructions on forking and submitting a PR
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)
## Other Resources
## Other Resources
Loading