Skip to content

Commit 7123c9b

Browse files
jmgatejmgate
authored
Merge pull request #2 from sandialabs/add-github-files
Add GitHub files
2 parents 4be6ebf + 017b544 commit 7123c9b

13 files changed

+1068
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug
3+
about: What went wrong?
4+
title: ''
5+
labels: 'Type: Bug'
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
* What went wrong?
12+
* What should have happened?
13+
* Do you have an idea what might fix things?
14+
* How has this bug affected you?
15+
* What are you trying to accomplish?
16+
17+
## Steps to Reproduce
18+
1. Machine/OS: [insert here]
19+
2. Reproducer:
20+
```
21+
# Insert minimal example script here.
22+
```
23+
3. Output from running the script:
24+
```
25+
# Paste all output from the terminal here.
26+
```
27+
28+
## Screenshots
29+
If applicable, add screenshots to help explain your problem.

‎.github/ISSUE_TEMPLATE/discussion.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Discussion
3+
about: What do we need to talk through?
4+
title: ''
5+
labels: 'Type: Discussion'
6+
assignees: ''
7+
8+
---
9+
10+
* What do we need to talk through?
11+
* Why do we need to talk through it?
12+
* What is needed for us to consider this discussion complete?
13+
* Be sure to @mention whoever should be involved in the discussion.

‎.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Documentation
3+
about: What's wrong with the docs?
4+
title: ''
5+
labels: 'Type: Documentation'
6+
assignees: ''
7+
8+
---
9+
10+
* What would you like to see in the documentation?
11+
* How does our current documentation not meet your needs?
12+
* How has this lack of documentation affected you?
13+
* What are you trying to accomplish?

‎.github/ISSUE_TEMPLATE/feature.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Feature
3+
about: What new functionality is needed?
4+
title: ''
5+
labels: 'Type: Feature'
6+
assignees: ''
7+
8+
---
9+
10+
* What feature change/addition is needed?
11+
* How does this differ from what we currently have?
12+
* Do you have suggestions on implementation?
13+
* What alternative solutions have you considered?
14+
* How has the lack of this feature affected you?
15+
* What are you trying to accomplish?
16+
* What specifically must we demonstrate to call this work complete?

‎.github/ISSUE_TEMPLATE/post-mortem.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Post-Mortem
3+
about: Let's track down the root cause of a failure
4+
title: ''
5+
labels: 'Type: Post-Mortem'
6+
assignees: ''
7+
8+
---
9+
10+
## What Went Wrong?
11+
Gather information and construct a detailed timeline of what contributed to the
12+
problem.
13+
14+
## Why Did It Go Wrong?
15+
This is not for the purpose of blame, but to educate the team such that we can
16+
learn from our mistakes.
17+
18+
## Proposed Countermeasures
19+
What changes can we implement to increase the likelihood that similar problems
20+
will not happen in the future?

‎.github/ISSUE_TEMPLATE/question.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Question
3+
about: What do you need to know?
4+
title: ''
5+
labels: 'Type: Question'
6+
assignees: ''
7+
8+
---
9+
10+
## Question
11+
* What can we help you with?
12+
* What is it you're trying to accomplish?
13+
* Why do you need to do what you're trying to do?
14+
15+
## Checklist
16+
* [ ] Have you read through the [README](README.md)?
17+
* [ ] Have you searched through [our documentation][docs]?
18+
19+
[docs]: https://staged-script.readthedocs.io

‎.github/ISSUE_TEMPLATE/refactor.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Refactor
3+
about: What needs rework?
4+
title: ''
5+
labels: 'Type: Refactor'
6+
assignees: ''
7+
8+
---
9+
10+
* What needs to be cleaned up?
11+
* How would the refactored implementation differ from what we have now?
12+
* What are the potential downsides to not dealing with the technical debt now
13+
and leaving it for later?

‎.github/ISSUE_TEMPLATE/task.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Task
3+
about: What needs to be done?
4+
title: ''
5+
labels: 'Type: Task'
6+
assignees: ''
7+
8+
---
9+
10+
## Description
11+
* What needs to happen?
12+
* Why does it need to happen?
13+
* How does it relate to the rest of the project?
14+
* What specifically must we demonstrate to call this work complete
15+
16+
## Tasks
17+
* [ ] First do this.
18+
* [ ] Then do that.
19+
* [ ] Also this other thing.

‎.github/pull_request_template.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<!--
2+
Delete all lines in this comment except the type of issue being addressed.
3+
**Type: Bug**
4+
**Type: Documentation**
5+
**Type: Feature**
6+
**Type: Refactor**
7+
**Type: Task**
8+
-->
9+
10+
## Description
11+
<!--
12+
Insert a brief description of the changes in this PR.
13+
-->
14+
15+
## Related Issues/PRs
16+
<!--
17+
Mention any issues or pull requests that this PR is related to. E.g.,
18+
* Closes #456.
19+
* Related to #123.
20+
* Etc.
21+
-->
22+
23+
## Motivation
24+
<!--
25+
If this wasn't covered in any related issues linked above, why was this change
26+
needed? What does it do for us?
27+
-->
28+
29+
## Implementation Details
30+
<!--
31+
If appropriate, why did you implement things the way you did? What
32+
alternatives did you consider? Are there any gotchas to be aware of? How does
33+
this set us up to be in a better place in the future? Etc.
34+
-->
35+
36+
## Screenshots/Recordings
37+
<!--
38+
If applicable, visually demonstrate the behavior before and after your changes.
39+
-->
40+
41+
42+
## Testing
43+
<!--
44+
Indicate what testing you added to cover your changes, and what testing you ran
45+
to ensure your changes are working as expected.
46+
-->
47+
48+
49+
## Documentation
50+
<!--
51+
Indicate how and where you've updated the documentation to cover your changes.
52+
-->

‎CODE_OF_CONDUCT.md

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone. We pledge to act and
7+
interact in ways that contribute to an open, welcoming, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our
12+
community include:
13+
14+
* Demonstrating understanding and kindness toward other people
15+
* Being respectful of differing opinions, viewpoints, and experiences
16+
* Giving and gracefully accepting constructive feedback
17+
* Accepting responsibility and apologizing to those affected by our mistakes,
18+
and learning from the experience
19+
* Focusing on what is best not just for us as individuals, but for the overall
20+
community
21+
22+
Examples of unacceptable behavior include:
23+
24+
* The use of sexualized language or imagery, and sexual attention or advances
25+
of any kind
26+
* Trolling, insulting or derogatory comments, and personal or political attacks
27+
* Public or private harassment
28+
* Publishing others' private information, such as a physical or email address,
29+
without their explicit permission
30+
* Other conduct which could reasonably be considered inappropriate in a
31+
professional setting
32+
33+
## Enforcement Responsibilities
34+
35+
Community leaders are responsible for clarifying and enforcing our standards of
36+
acceptable behavior and will take appropriate and fair corrective action in
37+
response to any behavior that they deem inappropriate, threatening, offensive,
38+
or harmful.
39+
40+
Community leaders have the right and responsibility to remove, edit, or reject
41+
comments, commits, code, wiki edits, issues, and other contributions that are
42+
not aligned to this Code of Conduct, and will communicate reasons for
43+
moderation decisions when appropriate.
44+
45+
## Scope
46+
47+
This Code of Conduct applies within all community spaces, and also applies when
48+
an individual is officially representing the community in public spaces.
49+
Examples of representing our community include using an official e-mail
50+
address, posting via an official social media account, or acting as an
51+
appointed representative at an online or offline event.
52+
53+
## Enforcement
54+
55+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
56+
reported to the community leaders responsible for enforcement by emailing
57+
[email protected]. All complaints will be reviewed and investigated promptly
58+
and fairly.
59+
60+
All community leaders are obligated to respect the privacy and security of the
61+
reporter of any incident.
62+
63+
## Enforcement Guidelines
64+
65+
Community leaders will follow these Community Impact Guidelines in determining
66+
the consequences for any action they deem in violation of this Code of Conduct:
67+
68+
### 1. Correction
69+
70+
**Community Impact**: Use of inappropriate language or other behavior deemed
71+
unprofessional or unwelcome in the community.
72+
73+
**Consequence**: A private, written warning from community leaders, providing
74+
clarity around the nature of the violation and an explanation of why the
75+
behavior was inappropriate. A public apology may be requested.
76+
77+
### 2. Warning
78+
79+
**Community Impact**: A violation through a single incident or series of
80+
actions.
81+
82+
**Consequence**: A warning with consequences for continued behavior. No
83+
interaction with the people involved, including unsolicited interaction with
84+
those enforcing the Code of Conduct, for a specified period of time. This
85+
includes avoiding interactions in community spaces as well as external channels
86+
like social media. Violating these terms may lead to a temporary or permanent
87+
ban.
88+
89+
### 3. Temporary Ban
90+
91+
**Community Impact**: A serious violation of community standards, including
92+
sustained inappropriate behavior.
93+
94+
**Consequence**: A temporary ban from any sort of interaction or public
95+
communication with the community for a specified period of time. No public or
96+
private interaction with the people involved, including unsolicited interaction
97+
with those enforcing the Code of Conduct, is allowed during this period.
98+
Violating these terms may lead to a permanent ban.
99+
100+
### 4. Permanent Ban
101+
102+
**Community Impact**: Demonstrating a pattern of violation of community
103+
standards, including sustained inappropriate behavior, harassment of an
104+
individual, or aggression toward or disparagement of classes of individuals.
105+
106+
**Consequence**: A permanent ban from any sort of public interaction within the
107+
community.
108+
109+
## Attribution
110+
111+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
112+
version 2.1, available at
113+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
114+
115+
Community Impact Guidelines were inspired by
116+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
117+
118+
For answers to common questions about this code of conduct, see the FAQ at
119+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
120+
[https://www.contributor-covenant.org/translations][translations].
121+
122+
[homepage]: https://www.contributor-covenant.org
123+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
124+
[Mozilla CoC]: https://github.com/mozilla/diversity
125+
[FAQ]: https://www.contributor-covenant.org/faq
126+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)