CONTRIBUTING.md

How to Contribute

We are glad you are reading this. We welcome your contribution.

Here are some important resources:

• Known Issues
• Active Proposals
• How to Test

Step by Step

How to Contribute to Use Cases.

How to Contribute Other Changes:

1. Fork this repository.
   ^{(unless you are a direct collaborator)}
2. Edit relevant files that need update.
   ^{(upload images as necessary)}
3. Commit your changes.
   ^{(write clear commit messages)}
4. Test your changes.
   ^{(if comfortable using a command prompt)}
5. Request a review.
   ^{(a.k.a. create a "Pull Request")}

Writing Commit Messages

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

A brief summary of the commit

A paragraph describing what changed and its impact.

Style Guide

Start reading our newer docs and you'll get the hang of it. We optimize for readability:

• We add a new line before starting a list
• We indent using tab character
• We create lists with asterisks
• We should use Markdown where possible¹
• We use some Python-Markdown extensions and PyMdown exensions²
• Use cwd-relative paths to images e.g. instead of /hpc/imgs/blah.gif, use ../imgs/blah.gif.³

Thanks,
Texas Advanced Computing Center

Footnotes

1. If some of our documents use HTML, please forgive us and use Markdown yourself. ↩

2. See enabled extensions at mkdocs.base.yml under markdown_extensions:. ↩

3. So that images load on the website and in GitHub preview. ↩