Contributing

Please use the following guidelines when contributing to this project.

Before contributing significant changes, please begin a discussion of the desired changes via a GitHub Issue to prevent doing unnecessary or overlapping work.

License

The preferred license for source code contributed to this project is the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0) and for documentation, including Jupyter notebooks and text documentation, is the Creative Commons Attribution 4.0 International (CC BY-NC 4.0) (https://creativecommons.org/licenses/by-nc/4.0/deed.en). Contributions under other, compatible licenses will be considered on a case-by-case basis.

Contributions must include a "signed off by" tag in the commit message for the contributions asserting the signing of the developers certificate of origin (https://developercertificate.org/). A GPG-signed commit with the "signed off by" tag is preferred.

Styling

Please use the following style guidelines when making contributions.

Jupyter Notebooks & Markdown

• When they appear inline with the text; directive names, clauses, function or subroutine names, variable names, file names, commands and command-line arguments should appear between two back ticks.

• Code blocks should begin with three back ticks and end with three back ticks.

• Emphasis, including quotes made for emphasis and introduction of new terms should be highlighted between a single pair of asterisks

• A level 1 heading should appear at the top of the notebook as the title of the notebook. .

Contributing Labs/Modules

A module should have the following directory structure:

• The base of the module should contain a START_HERE file with a brief introduction to the module and links to the individual labs for each language translation and programming language available.

Attribution

Portions adopted from https://github.com/OpenACC/openacc-training-materials/blob/master/CONTRIBUTING.md