Skip to content

Commit a2a3059

Browse files
committed
Move to FormidableLabs org
1 parent 8245b8b commit a2a3059

File tree

3 files changed

+175
-2
lines changed

3 files changed

+175
-2
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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, 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 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+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Development
2+
3+
Thanks for contributing! We love seeing continuous improvements
4+
and enhancements, no matter how small or big they might be.
5+
6+
## How to contribute?
7+
8+
We follow fairly standard but lenient rules around pull requests and issues.
9+
Please pick a title that describes your change briefly, optionally in the imperative
10+
mood if possible.
11+
12+
If you have an idea for a feature or want to fix a bug, consider opening an issue
13+
first. We're also happy to discuss and help you open a PR and get your changes
14+
in!
15+
16+
## How do I set up the project?
17+
18+
Luckily it's not hard to get started. You can install dependencies using yarn.
19+
Please don't use `npm` to respect the lockfile.
20+
21+
```sh
22+
yarn
23+
```
24+
25+
You can then run the build using:
26+
27+
```sh
28+
yarn build
29+
```
30+
31+
And you can run Flow to check for any type errors:
32+
33+
```sh
34+
yarn flow check
35+
```
36+
37+
## How do I test my changes?
38+
39+
It's always good practice to run the tests when making changes.
40+
It might also make sense to add more tests when you're adding features
41+
or fixing a bug, but we'll help you in the pull request, if necessary.
42+
43+
```sh
44+
yarn test # Single pass
45+
yarn test --watch # Watched
46+
yarn test --coverage # Single pass coverage report
47+
```
48+
49+
Sometimes it's a good idea to run the Jest in `production` mode,
50+
since some data structures and behaviour changes in React in
51+
`production`:
52+
53+
```sh
54+
NODE_ENV=production yarn test
55+
```
56+
57+
## How do I lint my code?
58+
59+
We ensure consistency in this codebase using `prettier`.
60+
It's run on a `precommit` hook, so if something's off it'll try
61+
to automatically fix up your code, or display an error.
62+
63+
If you have them set up in your editor, even better!
64+
65+
## How do I publish a new version?
66+
67+
If you're a core contributor or maintainer this will certainly come
68+
up once in a while.
69+
70+
Make sure you first create a new version. The following commands
71+
bump the version in the `package.json`, create a commit,
72+
and tag the commit on git:
73+
74+
```sh
75+
yarn version --new-version X
76+
# or
77+
npm version patch # accepts patch|minor|major
78+
```
79+
80+
Then run `npm publish` (npm is recommended here, not yarn)
81+
And maybe run `npm publish --dry-run` first to check the output.
82+
83+
```sh
84+
npm publish
85+
```
86+
87+
There's a `prepublishOnly` hook in place that'll clean and build
88+
the package automatically.
89+
90+
Don't forget to push afterwards:
91+
92+
```sh
93+
git push && git push --tags
94+
```
95+
96+
[This process can be simplified and streamlined by using `np`.](https://github.com/sindresorhus/np)

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
"description": "A custom partial React SSR renderer for prefetching and suspense",
55
"main": "index.js",
66
"source": "src/index.js",
7-
"author": "Phil Plückthun <phil@kitten.sh>",
7+
"author": "Phil Plückthun <phil[email protected]>",
88
"license": "MIT",
9+
"repository": "[email protected]:FormidableLabs/react-ssr-prepass.git",
910
"bugs": {
10-
"url": "https://github.com/kitten/react-ssr-prepass/issues"
11+
"url": "https://github.com/FormidableLabs/react-ssr-prepass/issues"
1112
},
1213
"files": [
1314
"index.js",

0 commit comments

Comments
 (0)