Skip to content

Commit 7e42c2a

Browse files
committed
Add issue and PR templates
1 parent 85f0725 commit 7e42c2a

File tree

8 files changed

+157
-2
lines changed

8 files changed

+157
-2
lines changed

.github/CODEOWNERS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @MatthewMckee4

.github/CODE_OF_CONDUCT.md

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

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
github: [matthewmckee4]
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Bug report
2+
description: Report an error or unexpected behavior
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Thank you for taking the time to report an issue! We're glad to have you involved with action-format.
8+
9+
**Before reporting, please make sure to search through [existing issues](https://github.com/MatthewMckee4/action-format/issues?q=is:issue+is:open+label:bug) (including [closed](https://github.com/MatthewMckee4/action-format/issues?q=is:issue%20state:closed%20label:bug)).**
10+
11+
- type: textarea
12+
attributes:
13+
label: Summary
14+
description: |
15+
A clear and concise description of the bug, including a minimal reproducible example.
16+
17+
Be sure to include the command you invoked (e.g., `action-format --diff`)
18+
19+
validations:
20+
required: true
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
name: Question
2+
description: Ask a question about action-format
3+
labels: ["question"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: Question
8+
description: Describe your question in detail.
9+
validations:
10+
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Summary
2+
3+
<!-- What's the purpose of the change? What does it do, and why? -->
4+
5+
## Test Plan
6+
7+
<!-- How was it tested? -->

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,5 +156,5 @@ jobs:
156156
with:
157157
token: ${{ secrets.CODECOV_TOKEN }}
158158
files: lcov.info
159-
slug: MatthewMckee4/seal
159+
slug: MatthewMckee4/action-format
160160
fail_ci_if_error: true

crates/action-format/tests/it/common/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ pub static INSTA_FILTERS: &[(&str, &str)] = &[
109109
(r"\\", "/"),
110110
// Rewrite Windows output to Unix output
111111
(r"\\([\w\d]|\.)", "/$1"),
112-
(r"seal\.exe", "seal"),
112+
(r"action-format\.exe", "action-format"),
113113
// Strip ANSI color codes (match ESC character using character class)
114114
(r"[\x1b]\[[0-9;]*m", ""),
115115
(r"\d+(?:;\d+)*m", ""),

0 commit comments

Comments
 (0)