Skip to content
This repository was archived by the owner on Feb 19, 2022. It is now read-only.

Commit 88cf347

Browse files
committed
Add COC, contribution docs, and maintainerd configuration.
1 parent 0410818 commit 88cf347

File tree

3 files changed

+181
-0
lines changed

3 files changed

+181
-0
lines changed

.maintainerd

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
log: true
2+
pullRequest:
3+
preamble: >
4+
The maintainers of this repo require that all pull request submitters adhere to the following:
5+
items:
6+
- prompt: >
7+
I have read and will comply with the
8+
[contribution guidelines](https://github.com/FormidableLabs/rapscallion/blob/master/CONTRIBUTE.md).
9+
default: false
10+
required: true
11+
- prompt: >
12+
I have read and will comply with the
13+
[code of conduct](https://github.com/FormidableLabs/rapscallion/blob/master/CONTRIBUTE.md).
14+
default: false
15+
required: true
16+
- prompt: All related documentation has been updated to reflect the changes made.
17+
default: false
18+
required: true
19+
- prompt: My commit messages are cleaned up and ready to merge.
20+
default: false
21+
required: true
22+
semver:
23+
enabled: true
24+
commit:
25+
subject:
26+
mustHaveLengthBetween: [8, 100]
27+
mustMatch: !!js/regexp /^(Fix|Enhancement|Feature|Docs|Other):\s.*/
28+
mustNotMatch: !!js/regexp /^fixup!/
29+
message:
30+
enforceEmptySecondLine: true
31+
linesMustHaveLengthBetween: [0, 100]
32+
issue:
33+
onLabelAdded:
34+
not-enough-information:
35+
action: comment
36+
data: |
37+
This issue has been tagged with the `not-enough-information` label. In order for us to help you,
38+
please respond with the following information:
39+
40+
- A description of the problem, including any relevant error output that can find.
41+
- A full repro, if possible. Otherwise, steps to reproduce.
42+
- The versions of the packages that you are using.
43+
- The operating system that you are using.
44+
- The browser or environment where the issue occurs.
45+
46+
If we receive no response to this issue within 2 weeks, the issue will be closed. If that happens,
47+
feel free to re-open with the requested information. Thank you!

COC.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Aggresive and/or demanding language
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or
42+
reject comments, commits, code, wiki edits, issues, and other contributions
43+
that are not aligned to this Code of Conduct, or to ban temporarily or
44+
permanently any contributor for other behaviors that they deem inappropriate,
45+
threatening, offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
## Enforcement
57+
58+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
59+
reported by contacting the author at <[email protected]>. All
60+
complaints will be reviewed and investigated and will result in a response that
61+
is deemed necessary and appropriate to the circumstances. The maintainers are
62+
obligated to protect confidentiality with regard to the reporter of an incident.
63+
Further details of specific enforcement policies may be posted separately.
64+
65+
Project maintainers who do not follow or enforce the Code of Conduct in good
66+
faith may face temporary or permanent repercussions as determined by other
67+
members of the project's leadership.
68+
69+
## Attribution
70+
71+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
72+
available at [http://contributor-covenant.org/version/1/4][version]
73+
74+
[homepage]: http://contributor-covenant.org
75+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTE.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contribute
2+
3+
If you're interested in adding features, reporting/fixing bugs, or just discussing the future of rapscallion, this is the place to start. Please feel free to reach out if you have questions or comments by opening an [issue](https://github.com/FormidableLabs/rapscallion/issues).
4+
5+
6+
## Adding new features
7+
8+
If there's a feature you'd like to see that isn't already in-progress or documented, there are two ways you can go about it:
9+
10+
- open an issue for discussion; or
11+
- fork and submit a PR.
12+
13+
Either way is fine, so long as you remember your PR may not be accepted as-is or at all. If a feature request is reasonable, though, it'll most likely be included one way or another.
14+
15+
Some other things to remember:
16+
17+
- Please respect the project layout and hierarchy, to keep things organized.
18+
- All code is linted. Outside of that, please try to conform to the code style and idioms that are used throughout the project.
19+
- Include descriptions for issues and PRs.
20+
- Please comply with the project's [code of conduct](./COC.md).
21+
22+
I'm busy and travel sometimes for work - so if I don't respond immediately, please be patient. I promise to reply!
23+
24+
## Commit message structure
25+
26+
Please follow the following commit message structure when submitting your pull request:
27+
28+
TYPE: Short commit message
29+
30+
Detailed
31+
commit
32+
info
33+
34+
For the value of **`TYPE`**, please use one of **`Feature`**, **`Enhancement`**, or **`Fix`**.
35+
36+
This is required in order to help us automate tasks such as changelog generation.
37+
38+
39+
# Bugs
40+
41+
If you encounter a bug, please check for an open issue that already captures the problem you've run into. If it doesn't exist yet, create it!
42+
43+
Please include as much information as possible, including:
44+
45+
- A full repro, if possible.
46+
- The versions of the packages that you're using.
47+
- The browser or environment where the issue occurs.
48+
- Any error messages or debug output that seems relevant.
49+
50+
If you're interested in tackling a bug, please say so.
51+
52+
53+
# Documentation
54+
55+
If you make changes, please remember to update the documentation to reflect the new behavior.
56+
57+
# Publishing
58+
59+
All changes are published automatically whenever a pull request is merged. As part of the PR process, you will be asked to provide the information necessary to make that happen.

0 commit comments

Comments
 (0)