Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
H
HCC docs
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Monitor
Service Desk
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Holland Computing Center
HCC docs
Commits
58c7e00c
Commit
58c7e00c
authored
5 years ago
by
Carrie A Brown
Browse files
Options
Downloads
Patches
Plain Diff
Update CONTRIBUTING.md
parent
73cb5d32
Branches
Branches containing commit
No related tags found
1 merge request
!144
Contributing
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
CONTRIBUTING.md
+15
-12
15 additions, 12 deletions
CONTRIBUTING.md
with
15 additions
and
12 deletions
CONTRIBUTING.md
+
15
−
12
View file @
58c7e00c
# 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,
fixes to existing material,
and bug reports are all welcome.
...
...
@@ -26,7 +29,8 @@ or a factual error.
but do not know how to use Git,
you can report problems or suggest improvements by
[
creating an issue
][
issues
]
.
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,
and would like to add or change material,
...
...
@@ -48,25 +52,24 @@ or a factual error.
## What to Contribute
There are many ways to contribute,
from writing new exercises and improving existing ones
to updating or filling in the documentation
and and submitting
[
bug reports
][
issues
]
from contributing additional documentation topics or submitting software specific job examples,
to updating or adding to existing documentation and submitting
[
bug reports
][
issues
]
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:
we are smarter together than we are on our own.
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.
## 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
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment