diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..5293b15 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,60 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making +participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, +disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, +religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take +appropriate and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, +issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the +project or its community. Examples of representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed representative at an online or offline +event. Representation of a project may be further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. The +project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the +circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent +repercussions as determined by other members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at +[http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..346c934 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,50 @@ +# Contributions + +🎉 Thanks for considering contributing to this project! 🎉 + +When contributing to this repository, please first discuss the change you wish to make via an +[issue](https://github.com/netlify/remix-template/issues/new/choose). Please use the issue templates. They are there to +help you and to help the maintainers gather information. + +Before working on an issue, ask to be assigned to it. This makes it clear to other potential contributors that someone +is working on the issue. + +When creating a PR, please use the template. The information in the template helps maintainers review your pull +request.``` + +This project was made with ❤️. The simplest way to give back is by starring and sharing it online. + +Everyone is welcome regardless of personal background. We enforce a [Code of conduct](CODE_OF_CONDUCT.md) in order to +promote a positive and inclusive environment. + +## Development process + +First fork and clone the repository. If you're not sure how to do this, please watch +[these videos](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github). + +Run: + +```bash +npm install +``` + +Make sure everything is correctly setup with: + +```bash +npm test +``` + +## How to write commit messages + +We use [Conventional Commit messages](https://www.conventionalcommits.org/) to automate version management. + +Most common commit message prefixes are: + +- `fix:` which represents bug fixes, and generate a patch release. +- `feat:` which represents a new feature, and generate a minor release. +- `feat!:`, `fix!:` or `refactor!:` and generate a major release. + +## Releasing + +1. Merge the release PR +2. Run `npm publish`