Skip to content

Commit 45e1530

Browse files
committed
chore: added a CoC and contributing guidelines
1 parent 330b1a5 commit 45e1530

File tree

2 files changed

+110
-0
lines changed

2 files changed

+110
-0
lines changed

CONDUCT.md

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

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributions
2+
3+
🎉 Thanks for considering contributing to this project! 🎉
4+
5+
When contributing to this repository, please first discuss the change you wish to make via an
6+
[issue](https://github.com/netlify/remix-template/issues/new/choose). Please use the issue templates. They are there to
7+
help you and to help the maintainers gather information.
8+
9+
Before working on an issue, ask to be assigned to it. This makes it clear to other potential contributors that someone
10+
is working on the issue.
11+
12+
When creating a PR, please use the template. The information in the template helps maintainers review your pull
13+
request.```
14+
15+
This project was made with ❤️. The simplest way to give back is by starring and sharing it online.
16+
17+
Everyone is welcome regardless of personal background. We enforce a [Code of conduct](CODE_OF_CONDUCT.md) in order to
18+
promote a positive and inclusive environment.
19+
20+
## Development process
21+
22+
First fork and clone the repository. If you're not sure how to do this, please watch
23+
[these videos](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github).
24+
25+
Run:
26+
27+
```bash
28+
npm install
29+
```
30+
31+
Make sure everything is correctly setup with:
32+
33+
```bash
34+
npm test
35+
```
36+
37+
## How to write commit messages
38+
39+
We use [Conventional Commit messages](https://www.conventionalcommits.org/) to automate version management.
40+
41+
Most common commit message prefixes are:
42+
43+
- `fix:` which represents bug fixes, and generate a patch release.
44+
- `feat:` which represents a new feature, and generate a minor release.
45+
- `feat!:`, `fix!:` or `refactor!:` and generate a major release.
46+
47+
## Releasing
48+
49+
1. Merge the release PR
50+
2. Run `npm publish`

0 commit comments

Comments
 (0)