Skip to content

Commit fa5a84f

Browse files
committed
adding a barebone contribution guide. Please discuss!
1 parent d7cf819 commit fa5a84f

1 file changed

Lines changed: 27 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,34 @@
11
# Contributing to GPUE
22

3-
TBD
3+
GPUE is primarly developed for scientific applications on high-performance computing systems.
4+
As such, all submissions will be expected to run on various Linux-based hardware with a focus on performance and usability.
45

6+
If there are any questions related to the current status of GPUE, please refer to the [documentation](https://gpue-group.github.io/).
57

8+
## Bug reports and issues
9+
10+
If any problem arises while using GPUE code, please open an issue in the [primary fork of GPUE](https://github.com/GPUE-group/GPUE).
11+
There are four general issue labels to use:
12+
13+
1. Physical inaccuracies -- These are considered breaking bugs and will be addressed immediately.
14+
2. Usability issues -- These are problems running GPUE, ranging from compilation errors to problems with equation parsing. These are also considered breaking bugs and will be addressed according to the severity of the problem.
15+
3. General problem -- any issue that is not related to physical inaccuracies or usability. These will be addressed depending on severity and submission date.
16+
4. Feature request -- These are for anything we are missing in GPUE and will be addressed based on novelty and utility.
17+
18+
## Pull requests
19+
20+
If you wish to submit code via Pull Request (PR) directly to GPUE, please first create an issue, as outlined above.
21+
All four previously defined labels apply to PRs.
22+
Please refer to the corresponding issues in PRs.
23+
24+
All PRs will be tested with the `gpue -u` command and if the PR intends to create a new feature, this feature must be tested with a function in the `src/unit_test.cu` file.
25+
26+
In addition, if the PR is sufficiently advanced (as indicated by previous contributors) please update the [documentation](https://gpue-group.github.io/) accordingly with the contents of the PR.
27+
28+
### Style guide
29+
30+
There is no formal style guide for GPUE, but it follows standard conventions for CUDA programming, favoring C-style syntax when possible.
31+
Each PR should have the appropriate Doxygen formatting and each feature PR will be reviewed on overall performance and usability.
632

733

834
# Code Of Conduct

0 commit comments

Comments
 (0)