forked from remix-run/remix
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
183 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,125 @@ | ||
# Code of Conduct | ||
|
||
tl;dr: Be excellent to each other! | ||
|
||
## Our Pledge | ||
|
||
We as members, contributors, and leaders pledge to make participation in our | ||
community a harassment-free experience for everyone, regardless of age, body | ||
size, visible or invisible disability, ethnicity, sex characteristics, gender | ||
identity and expression, level of experience, education, socio-economic status, | ||
nationality, personal appearance, race, religion, or sexual identity | ||
and orientation. | ||
|
||
We pledge to act and interact in ways that contribute to an open, welcoming, | ||
diverse, inclusive, and healthy community. | ||
|
||
## Our Standards | ||
|
||
Examples of behavior that contributes to a positive environment for our | ||
community include: | ||
|
||
- Demonstrating empathy and kindness toward other people | ||
- Being respectful of differing opinions, viewpoints, and experiences | ||
- Giving and gracefully accepting constructive feedback | ||
- Accepting responsibility and apologizing to those affected by our mistakes, | ||
and learning from the experience | ||
- Focusing on what is best not just for us as individuals, but for the | ||
overall community | ||
|
||
Examples of unacceptable behavior include: | ||
|
||
- The use of sexualized language or imagery, and sexual attention or | ||
advances of any kind | ||
- Trolling, insulting or derogatory comments, and personal or political attacks | ||
- Public or private harassment | ||
- Publishing others' private information, such as a physical or email | ||
address, without their explicit permission | ||
- Other conduct which could reasonably be considered inappropriate in a | ||
professional setting | ||
|
||
## Enforcement Responsibilities | ||
|
||
Community leaders are responsible for clarifying and enforcing our standards of | ||
acceptable behavior and will take appropriate and fair corrective action in | ||
response to any behavior that they deem inappropriate, threatening, offensive, | ||
or harmful. | ||
|
||
Community leaders 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, and will communicate reasons for moderation | ||
decisions when appropriate. | ||
|
||
## Scope | ||
|
||
This Code of Conduct applies within all community spaces, and also applies when | ||
an individual is officially representing the community in public spaces. | ||
Examples of representing our community include using an official e-mail address, | ||
posting via an official social media account, or acting as an appointed | ||
representative at an online or offline event. | ||
|
||
## Enforcement | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported to the community leaders responsible for enforcement at [email protected]. | ||
All complaints will be reviewed and investigated promptly and fairly. | ||
|
||
All community leaders are obligated to respect the privacy and security of the | ||
reporter of any incident. | ||
|
||
## Enforcement Guidelines | ||
|
||
Community leaders will follow these Community Impact Guidelines in determining | ||
the consequences for any action they deem in violation of this Code of Conduct: | ||
|
||
### 1. Correction | ||
|
||
**Community Impact**: Use of inappropriate language or other behavior deemed | ||
unprofessional or unwelcome in the community. | ||
|
||
**Consequence**: A private, written warning from community leaders, providing | ||
clarity around the nature of the violation and an explanation of why the | ||
behavior was inappropriate. A public apology may be requested. | ||
|
||
### 2. Warning | ||
|
||
**Community Impact**: A violation through a single incident or series | ||
of actions. | ||
|
||
**Consequence**: A warning with consequences for continued behavior. No | ||
interaction with the people involved, including unsolicited interaction with | ||
those enforcing the Code of Conduct, for a specified period of time. This | ||
includes avoiding interactions in community spaces as well as external channels | ||
like social media. Violating these terms may lead to a temporary or | ||
permanent ban. | ||
|
||
### 3. Temporary Ban | ||
|
||
**Community Impact**: A serious violation of community standards, including | ||
sustained inappropriate behavior. | ||
|
||
**Consequence**: A temporary ban from any sort of interaction or public | ||
communication with the community for a specified period of time. No public or | ||
private interaction with the people involved, including unsolicited interaction | ||
with those enforcing the Code of Conduct, is allowed during this period. | ||
Violating these terms may lead to a permanent ban. | ||
|
||
### 4. Permanent Ban | ||
|
||
**Community Impact**: Demonstrating a pattern of violation of community | ||
standards, including sustained inappropriate behavior, harassment of an | ||
individual, or aggression toward or disparagement of classes of individuals. | ||
|
||
**Consequence**: A permanent ban from any sort of public interaction within | ||
the community. | ||
|
||
## Attribution | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant][homepage], | ||
version 2.0, available at | ||
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. | ||
|
||
Community Impact Guidelines were inspired by [Mozilla's code of conduct | ||
enforcement ladder](https://github.com/mozilla/diversity). | ||
|
||
[homepage]: https://www.contributor-covenant.org |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
Remix is a commercial project developed by React Training LLC. | ||
|
||
We do not ask for contributions from our subscribers. After all, that's what | ||
you're paying *us* for. 😅 | ||
|
||
However, if there is something that you'd like to contribute, whether it's a bug | ||
fix to scratch your own itch or a typo that you just can't overlook in the docs, | ||
we'd be happy to have your contribution. But we need you to sign a contributor | ||
license agreement (CLA) first that assigns us ownership so we are able to | ||
include it in the software we sell. | ||
|
||
We don't yet have a CLA, but we are working on it and we will be able to accept | ||
your contributions once we do. Until then, please keep letting us know about our | ||
bugs and typos in Discord and we will do our best to address them. | ||
|
||
Thank you for your patience! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
We currently use `yarn` ([version 1](https://classic.yarnpkg.com/lang/en/)) to | ||
develop Remix. But don't get too attached to it. We'll be migrating to npm 7 | ||
soon. | ||
|
||
## Development | ||
|
||
```bash | ||
# install everything | ||
yarn install | ||
|
||
# run the build | ||
yarn build | ||
|
||
# run the tests | ||
yarn test | ||
# run the tests for a specific package | ||
yarn test react | ||
# run the tests in watch mode | ||
yarn test react --watch | ||
|
||
# cut a release | ||
yarn run version major|minor|patch|prerelease [prereleaseId] | ||
yarn run publish | ||
# or, to automatically publish from GitHub Actions | ||
git push origin --follow-tags | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,25 @@ | ||
# Welcome to Remix development! | ||
# Welcome to Remix! | ||
|
||
Remix is a framework for shipping better websites. | ||
Remix is a framework for building better websites using modern web standards and | ||
best practices. We are happy you're here! | ||
|
||
## Development | ||
This repository contains the Remix source code. It's a work in progress, so we | ||
appreciate your patience as we figure things out. | ||
|
||
```bash | ||
# install everything | ||
yarn install | ||
## Documentation | ||
|
||
# run the build | ||
yarn build | ||
For documentation about Remix, please visit [our website](https://docs.remix.run). | ||
|
||
# run the tests | ||
yarn test | ||
# run the tests for a specific package | ||
yarn test react | ||
# run the tests in watch mode | ||
yarn test react --watch | ||
The documentation is automatically generated on each release from the files in | ||
[the `docs` directory](docs). | ||
|
||
# cut a release | ||
yarn run version major|minor|patch|prerelease [prereleaseId] | ||
yarn run publish | ||
# or, to automatically publish from GitHub Actions | ||
git push origin --follow-tags | ||
## Contributing | ||
|
||
# cut a prerelease | ||
# make a branch to hold your commits | ||
git checkout -b release/0.8.0 | ||
If you're interested in contributing code and/or documentation, please [read | ||
this first](CONTRIBUTING.md). | ||
|
||
# add the pre release tag | ||
yarn run version prerelease pre | ||
## Code of Conduct | ||
|
||
# push as usual | ||
git push origin release/0.8.0 --follow-tags | ||
``` | ||
|
||
## Roadmap | ||
|
||
- dev server | ||
- changes to loaders appear when you reload the page | ||
- changes to components immediately show up | ||
- changes to styles immediately show up | ||
- dev server proxy function for various platforms | ||
Please see our [code of conduct](CODE_OF_CONDUCT.md) for any questions about the | ||
kind of community we are trying to build here and what to do if you need help | ||
with someone who is not acting professionally. |