Skip to content

Commit c49c55e

Browse files
calebe94calebe94
authored
Merge pull request #147 from Calebe94/146_add_templates
[#146] Added issues and PR templates
2 parents 55bc081 + 14b1c3c commit c49c55e

File tree

6 files changed

+239
-0
lines changed

6 files changed

+239
-0
lines changed

‎.github/CODE_OF_CONDUCT.md‎

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

‎.github/CONTRIBUTING.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
- **IMPORTANT**: Bandwidth for pull request review is currently quite limited. If you
2+
want to contribute where it's most needed, please consider reviewing or testing
3+
open pull requests.
4+
5+
- Before you start to work on something, please leave a comment on the relevant
6+
issue (or open one). This makes sure there is no duplicate work done.
7+
8+
- If you are stuck somewhere or have questions, [please ask](https://github.com/Calebe94/tinytools/discussions)!
9+

‎.github/ISSUE_TEMPLATE/1_Bug_report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: 🐛 Bug Report
3+
about: Report errors and problems
4+
5+
---
6+
7+
<!--- Provide a general summary of the issue in the Title above -->
8+
9+
## Expected Behavior
10+
<!--- Tell us what should happen -->
11+
12+
## Current Behavior
13+
<!--- Tell us what happens instead of the expected behavior -->
14+
15+
## Possible Solution
16+
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
17+
18+
## Steps to Reproduce
19+
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
20+
<!--- reproduce this bug. Include code to reproduce, if relevant -->
21+
1.
22+
2.
23+
3.
24+
4.
25+
26+
## Context (Environment)
27+
<!--- How has this issue affected you? What are you trying to accomplish? -->
28+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
29+
30+
<!--- Provide a general summary of the issue in the Title above -->
31+
32+
## Detailed Description
33+
<!--- Provide a detailed description of the change or addition you are proposing -->
34+
35+
## Possible Implementation
36+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->

‎.github/ISSUE_TEMPLATE/2_Feature_request.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: 🚀 Feature Request
3+
about: Ideas for new features and improvements
4+
5+
---
6+
<!--- Provide a general summary of the issue in the Title above -->
7+
8+
## Expected Behavior
9+
<!--- Tell us what should happen -->
10+
11+
## Context (Environment)
12+
<!--- Why should we implement this new feature? How has this issue affected you? What are you trying to accomplish? -->
13+
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
14+
15+
<!--- Provide a general summary of the issue in the Title above -->
16+
17+
## Detailed Description
18+
<!--- Provide a detailed description of the change or addition you are proposing -->
19+
20+
## Possible Implementation
21+
<!--- Not obligatory, but suggest an idea for implementing addition or change -->

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: ❓ Support Question
4+
url: https://github.com/Calebe94/tinytools/discussions
5+
about: Use GitHub's new discussions feature for questions

‎.github/pull_request_template.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!-- Thanks for submitting a pull request! Please pick a descriptive title (not just "issue 12345"). If there is an open issue associated to your PR, please add a line like "Closes #12345" somewhere in the PR description (outside of this comment) -->
2+
<!--- Provide a general summary of your changes in the Title above -->
3+
4+
## Description
5+
<!--- Describe your changes in detail -->
6+
7+
## Related Issue
8+
<!--- This project only accepts pull requests related to open issues -->
9+
<!--- If suggesting a new feature or change, please discuss it in an issue first -->
10+
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
11+
<!--- Please link to the issue here: -->
12+
13+
## Motivation and Context
14+
<!--- Why is this change required? What problem does it solve? -->
15+
16+
## How Has This Been Tested?
17+
<!--- Please describe in detail how you tested your changes. -->
18+
<!--- Include details of your testing environment, and the tests you ran to -->
19+
<!--- see how your change affects other areas of the code, etc. -->
20+
21+
## Screenshots (if appropriate):
22+
23+
## Types of changes
24+
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
25+
- [ ] Bug fix (non-breaking change which fixes an issue)
26+
- [ ] New feature (non-breaking change which adds functionality)
27+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
28+
29+
## Checklist:
30+
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
31+
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
32+
- [ ] My code follows the code style of this project.
33+
- [ ] My change requires a change to the documentation.
34+
- [ ] I have updated the documentation accordingly.

0 commit comments

Comments
 (0)