Skip to content
This repository has been archived by the owner on Mar 12, 2021. It is now read-only.

Update cra fork #2

Merged
merged 190 commits into from Jan 3, 2020
Merged
Show file tree
Hide file tree
Changes from 189 commits
Commits
Show all changes
190 commits
Select commit Hold shift + click to select a range
498913d
Add question issue template (#7423)
iansu Jul 25, 2019
aa3e221
Update deploy instructions in contributing guide (#7429)
iansu Jul 25, 2019
67a2088
Remove labels from pull request template
iansu Jul 25, 2019
cbad256
Add explicit check for --watchAll=false (#7433)
mrmckeb Jul 26, 2019
404af90
Add ESLint 6 support (#7415)
mrmckeb Jul 28, 2019
567f36c
Update testing-library package names in README (#7340)
balazsorban44 Jul 29, 2019
b96ac6c
Update ESlint Install Docs (#7451)
mrmckeb Jul 30, 2019
032cdf7
Improve bootstrap docs when using custom SCSS (#7462)
eclectic-coding Aug 1, 2019
30fc0bf
Suggest `jsx: "react"` in tsconfig (#7472)
Aug 4, 2019
066053c
Set jsonpFunction to prevent conflicts (#5951)
sibiraj-s Aug 5, 2019
914c95e
Resolve relative paths for preprocessor styles (#5829)
Aug 6, 2019
ae671dc
Specify roots in Jest config (#7480)
mucsi96 Aug 7, 2019
65a891c
Optimise templates for Lighthouse (#7482)
dscanlan Aug 7, 2019
ea2bcb7
Use readConfigFile instead of require for tsconfig (#7248)
jackjocross Aug 7, 2019
eaf0b17
Fix HMR in Firefox when proxy option present (#7444)
dmile Aug 7, 2019
cff4046
Adjusted deployment documentation for ZEIT Now (#7488)
leo Aug 8, 2019
91c2673
Bump dependencies (#7473)
ianschmitz Aug 8, 2019
9678bbb
Support configuring coveragePathIgnorePatterns (#7080)
Aug 8, 2019
efaee65
Fix RegExp from navigateFallbackBlacklist (workbox) (#7176)
nuragic Aug 8, 2019
cb2c720
Fix launch.json debugging config (#6484)
ryan-mars Aug 8, 2019
b225842
Add vscodium to the editor list (#7028)
leonardodino Aug 8, 2019
a48a054
Bump version of sass-loader (#7496)
xiaoxiangmoe Aug 9, 2019
538943f
Add readonly modifier for css module (#7497)
xiaoxiangmoe Aug 9, 2019
f09d3d3
Remove unused dependencies in babel-preset-react-app (#5818)
iansu Aug 9, 2019
dbe7967
Prepare 3.1.0 release
iansu Aug 9, 2019
a78ff74
Publish
iansu Aug 9, 2019
70febc7
Add links to Spectrum in README and docs (#7500)
iansu Aug 10, 2019
c0b4173
Update bug report issue template
iansu Aug 10, 2019
a21e6b1
Don't block static files in robots.txt (#7508)
iansu Aug 12, 2019
413e7c8
Ignore "jsx-a11y/aria-role" for React components (#7393)
deftomat Aug 12, 2019
cbf2134
Update docusaurus config (#7499)
iansu Aug 13, 2019
4a84cd4
Update Netlify config (#7527)
iansu Aug 13, 2019
cbaed7f
Fix ESLint 6 support (#7513)
ianschmitz Aug 13, 2019
094983d
Prepare 3.1.1 release
iansu Aug 13, 2019
4410f5e
Publish
iansu Aug 13, 2019
437b83f
Show logo on mobile docs (#7521)
GrooChu Aug 14, 2019
6466282
Add a migration step to remove static directory from robots.txt (#7536)
lookfirst Aug 16, 2019
24780bb
docs: update Flow documentation (#7550)
FezVrasta Aug 16, 2019
fbb3b03
Correct proxy usage docs (#7368)
szabolcs-szilagyi Aug 19, 2019
6560858
Remove trailing spaces from manifest.json (#7585)
xiaoxiangmoe Aug 23, 2019
567787b
Link changelogs between major versions (#7613)
emilpalsson Aug 30, 2019
6dec056
Remove cleanup-after-each example (#7620)
iHmD Sep 2, 2019
78fb4cf
Adopt Contributor Covenant (#7650)
iansu Sep 6, 2019
1f46136
Fix build (#7662)
ianschmitz Sep 9, 2019
bb31710
Disable babel-loader's cacheCompression (#7633)
jleclanche Sep 9, 2019
aafc7ff
Update troubleshooting.md (#7459)
prevostc Sep 9, 2019
c9b9504
Explicitly check that EXTEND_ESLINT is true (#7538)
BrockWills Sep 9, 2019
0f9e350
Update running-tests.md (#7659)
weyert Sep 9, 2019
b3f8ef2
Bump version of @typescript-eslint/* (#7540)
pierreneter Sep 11, 2019
edb3411
Upgrade dotenv-expand to fix issues (#7531)
sekoyo Sep 11, 2019
71c4d11
Minor performance improvements (#7587)
deftomat Sep 11, 2019
74eb65a
Remove --single-quote from prettier examples (#7663)
brlewis Sep 11, 2019
8b7b819
Use const instead of var in env.js (#7526)
Primajin Sep 13, 2019
4d533d4
Change runtime chunk name separator from tilde to dash (#7679)
javadoug Sep 13, 2019
7ac8150
Bump dependencies (#7681)
ianschmitz Sep 14, 2019
a1afaa6
Update deployment.md with another AWS example (#7616)
AndrewBestbier Sep 17, 2019
ff15a08
Add new logo (#7704)
iansu Sep 19, 2019
e0719e4
Prepare 3.1.2 release
iansu Sep 19, 2019
a825e8f
Publish
iansu Sep 19, 2019
0dc69ec
Update runtime chunk name separator in docs (#7705)
samuelmeuli Sep 19, 2019
05f7924
Remove 'shortcut' link type before 'icon' (#7707)
lewislbr Sep 20, 2019
b1e6155
Guard polyfills against window possibly being undefined (#7205)
jxom Sep 24, 2019
6f5221c
Enable .eslintignore with extend flag (#7562)
igtm Sep 24, 2019
93150c5
Add "entrypoints" key to asset manifest (#7721)
samuelmeuli Sep 24, 2019
0d1775e
Update adding flow documentation (#7731)
FezVrasta Sep 25, 2019
42ee721
set output.globalObject to 'this' (#7742)
Sep 26, 2019
6533a6d
Update logic and log errors for EXTEND_ESLINT (#7530)
n1ru4l Sep 27, 2019
e624b75
update list of supported jest config overrides (#7601)
neilbryson Sep 27, 2019
4a3718b
Upgrade Webpack version (#7740)
RDIL Sep 30, 2019
c0d73ba
Close br tags in template README files (#7668)
rakannimer Sep 30, 2019
fefd716
Fix variable name casing in fileTransform (#7752)
lewislbr Sep 30, 2019
a10223d
Documentation typo fix (#7757)
tomer Sep 30, 2019
6f7b371
Fix linting error when using rest props (#7754)
alexandrtovmach Oct 1, 2019
71946b1
Add TSC_COMPILE_ON_ERROR setting (#6931)
kylebebak Oct 1, 2019
f36d61a
Remove switch case (#7729)
andrelmlins Oct 1, 2019
6980616
docs: note that v2 to v3 migration may require deletion of node_modul…
kimpers Oct 1, 2019
85aac9b
Stop hiding the column number of ESLint errors (#6980)
justingrant Oct 1, 2019
7e2b6b1
Support setting baseUrl to root directory (#7755)
robertvansteen Oct 2, 2019
6b8fa00
Use installing package manager in README (#7687)
ashr81 Oct 2, 2019
88cf8cd
Support production profiling with React Developer Tools (#7737)
JacobMGEvans Oct 3, 2019
6a74342
Prepare 3.2.0 release
iansu Oct 3, 2019
7fae307
Publish
iansu Oct 3, 2019
e51ea13
Temporarily disable Windows in CI (#7773)
ianschmitz Oct 3, 2019
ac93f31
Add babel runtime version to transform-runtime plugin to reduce… (#7726)
topaxi Oct 6, 2019
09cbb89
Add Babel sourcemap to resolve VSCode debugging issues (#7022)
justingrant Oct 10, 2019
9161ba8
Fix process type in TypeScript template (#7796)
fuszenecker Oct 10, 2019
f06ae8b
Account for browserslist environment variables (#7764)
Oct 11, 2019
c8ca307
Clarify dynamic import stage in docs (#7813)
aprilandjan Oct 13, 2019
dc4d62d
Update adding-typescript.md (#7815)
orta Oct 14, 2019
ab41c4c
Document how to use the .env file to enforce HTTPS (#7821)
TomasHubelbauer Oct 14, 2019
889df8e
Fix absolute paths issue in Jest (#7822)
robertvansteen Oct 14, 2019
4a4ae1e
Document correct default behavior for HOST var (#7823)
jsejcksn Oct 15, 2019
81c48dc
Fix grammar error in troubleshooting.md (#7824)
jakeboone02 Oct 15, 2019
9243305
Upgrade to docusaurus 2 (#7785)
endiliey Oct 15, 2019
b4068f2
Update doc publishing instructions
iansu Oct 15, 2019
584e352
Revert logo in templates (#7830)
iansu Oct 16, 2019
2da645c
feat: add additional Jest keys to whitelist (#7832)
mrmckeb Oct 16, 2019
ca37609
Link to React documentation for code splitting (#7686)
Hugodby Oct 16, 2019
053f977
Add a note about .eslingignore files being respected (#7809)
seanlaff Oct 16, 2019
4b024e9
added check for typescript template and unsupported node version (#7839)
awaseem Oct 17, 2019
ce968a9
Update getting-started.md (#7841)
reactjser Oct 18, 2019
07470fd
Link to ASP.NET Core docs (#7840)
Daniel15 Oct 19, 2019
da06c23
Update readme gif links (#7849)
cchanxzy Oct 20, 2019
9455ec5
Update adding-bootstrap.md (#7853)
Xuhao Oct 21, 2019
f337acc
Move unused eslint webpack import into @remove-on-eject block (#7856)
mrseanbaines Oct 21, 2019
9d00fce
📖 DOC: Improvement (#7819)
waahab Oct 21, 2019
7690af5
Upgrade terser & enable parallel minification in wsl (#7857)
endiliey Oct 21, 2019
9788522
Add a GitHub Action that runs the build script (#7861)
iansu Oct 22, 2019
42140e5
Edit InterpolateHtmlPlugin hook (#6448) (#6449)
GuiHash Oct 23, 2019
5ea3b34
Fix notations of loopback addresses (#7474)
wataash Oct 23, 2019
ea34c1d
Add Service-Worker header to checkValidServiceWorker (#6753)
darthmaim Oct 23, 2019
a351750
Add additional information for postcss errors (#6282) (#6352)
buildbreakdo Oct 23, 2019
4582491
Fix eslint complaints in build.js (#7870)
andriijas Oct 24, 2019
1d03579
Add Alex to lint documentation (#7852)
iansu Oct 24, 2019
a51729c
Bump docusaurus 🦖 (#7874)
andriijas Oct 24, 2019
c24314d
Dark scheme overlay (#7052)
Fabianopb Oct 24, 2019
7efe29b
Bump react (#7875)
andriijas Oct 24, 2019
f79f303
Bump styling related loaders (#7876)
andriijas Oct 24, 2019
e92db94
Remove alex precommit check (#7878)
iansu Oct 24, 2019
4c0c819
Add template support (#7716)
mrmckeb Oct 24, 2019
facd8f9
Prepare 3.3.0 beta
iansu Oct 24, 2019
3e7391d
If template name already starts with cra-template leave it alone (#7880)
iansu Oct 24, 2019
07ccad7
Update prerelease publishing instructions
iansu Oct 24, 2019
324428f
Upgrade packages and tweak config to adapt to new config format (#7814)
andriijas Oct 25, 2019
971f249
refactor: remove double coerce (#7882)
mrmckeb Oct 27, 2019
c34aa13
Add yarn.lock to .gitignore (#7789)
lukyth Oct 27, 2019
165765d
chore: Fix broken link for CRA deployment (#7897)
haruelrovix Oct 29, 2019
2c45a3c
chore: Fix broken link for e2e README (#7896)
haruelrovix Oct 29, 2019
2de57fe
Add @testing-library to the default templates (#7881)
kentcdodds Oct 29, 2019
b4fe788
Add numeric separator support (#7817)
tharun208 Oct 30, 2019
b68c777
Update open (#7910)
andriijas Oct 31, 2019
6d6dfa9
Mark TypeScript as an optional peer dependency (#7860)
dstaley Oct 31, 2019
9750738
Add restoreMocks to supported jest config keys (#7921)
ianschmitz Nov 3, 2019
d46da89
fix seperators typo (#7932)
donavon Nov 5, 2019
10daea2
No spinning React logo if `prefers-reduced-motion` (#7931)
donavon Nov 6, 2019
0c9fa8d
Made PRs welcome badge point to contributors guide (#7792)
jamesgeorge007 Nov 6, 2019
8a1ee2f
Make JavaScript and TypeScript templates consistent (#7944)
suprj Nov 7, 2019
211694a
Fix CI (#7951)
ianschmitz Nov 9, 2019
d12b4b6
Add optional chaining and nullish coalescing operators support (#7438)
renatoagds Nov 9, 2019
5cdc3cc
Add tests for optional chaining and null coalescing (#7952)
ianschmitz Nov 9, 2019
f01bfac
Upgrade jest-watch-typeahead (#7956)
Andarist Nov 10, 2019
30b491b
Fix light background in docusaurus night mode (#7936)
heyimalex Nov 13, 2019
915108b
Add placeholders where old template READMEs used to be (#7972)
iansu Nov 13, 2019
9df95df
Temporarily disable GitHub Actions (#7978)
iansu Nov 14, 2019
3d6d0a1
Prepare 3.3.0 beta
iansu Nov 14, 2019
58b4738
Bump dependencies (#7986)
ianschmitz Nov 16, 2019
e7cdde6
Support scoped templates (#7991)
klasbj Nov 18, 2019
3aaa3fa
Add contributors section to readme (#7995)
ianschmitz Nov 18, 2019
4b4f3f2
added e2e test for checking typescript template with unsupported node…
awaseem Nov 18, 2019
df5088d
Unpin dependencies in react-app-polyfill (#7999)
ianschmitz Nov 19, 2019
23d5776
Add scripts support to templates (#7989)
mrmckeb Nov 19, 2019
4604c5e
Override no-unused-expressions with the typescript-eslint version (#8…
maxdavidson Nov 20, 2019
5d24a5e
Prefix apple-touch-icon links with PUBLIC_URL. (#8005)
benblank Nov 24, 2019
82009f5
Bump webpack-dev-server (#7988)
ianschmitz Nov 24, 2019
1a66971
Bump dependencies (#8024)
ianschmitz Nov 24, 2019
99d71f3
Re-enable GitHub Actions (#8029)
iansu Nov 25, 2019
821fe6b
Update CHANGELOG
iansu Nov 27, 2019
6a3ccc3
Update CODEOWNERS
iansu Nov 27, 2019
fffc777
Remove no-unexpected-multiline rule (#8039)
iansu Nov 28, 2019
f6ba862
Add TypeScript peer dependency to react-scripts (#8038)
iansu Nov 28, 2019
29c5e55
Update template docs (#8050)
mrmckeb Nov 29, 2019
9654bef
Prepare 3.3.0 release
iansu Dec 4, 2019
0b45600
Update CHANGELOG
iansu Dec 4, 2019
9a817dd
Publish
iansu Dec 5, 2019
9f4cb4f
webpackHotDev now uses wss when https is used (#8079)
mikecaulley Dec 5, 2019
2ace7c2
Add custom-templates to docs sidebar (#8077)
ianschmitz Dec 5, 2019
8330e7c
Fix typo in CHANGELOG.md (#8080)
Trontor Dec 6, 2019
b19bffe
Remove error for @typescript-eslint/no-namespace (#7803)
szhu Dec 6, 2019
0b293e9
Fix CI build (#8122)
ianschmitz Dec 9, 2019
0327d89
Fix CSS font-face minification (#8106)
sidonaldson Dec 9, 2019
53a48c4
Add slashes to WebSocket protocol URL (#8116)
Baael Dec 9, 2019
b8ff97b
Fix typo in comment: `?.` is right, not `.?` (#8124)
vadzim Dec 9, 2019
1f1594d
chore: update docusaurus & tweak site (#8111)
endiliey Dec 10, 2019
8d1a4f2
[Security] Update terser webpack plugin (#8102)
RDIL Dec 11, 2019
c52487a
feat(react-scripts): allow PUBLIC_URL in develoment mode
ericclemmons Jan 26, 2019
ebcffda
Add current version and bin location to --info output (#8168)
heyimalex Dec 13, 2019
9922275
Bump pkgUp (#8163)
andriijas Dec 13, 2019
349a92a
Bump chalk (#8164)
andriijas Dec 13, 2019
ab2976f
Add link to Netlify in README
iansu Dec 13, 2019
f26de73
Bump internal dependencies (#8176)
andriijas Dec 14, 2019
f314855
Add package-runner note to readme (#8132)
JeromeDeLeon Dec 15, 2019
1a13b59
Update PWA docs links to point to template package (#8147)
peet Dec 15, 2019
30eaab4
Minor refactors in create-react-app (#8178)
heyimalex Dec 16, 2019
18e56da
fix: proactively append to .gitignore during init (#8028)
bmuenzenmeyer Dec 18, 2019
88a5435
Bump babel-plugin-tester and fix breaking changes (#8171)
andriijas Dec 19, 2019
12e8dd4
feat(react-scripts): allow PUBLIC_URL in develoment mode
iamandrewluca Jan 26, 2019
d6ee8ce
Merge branch 'public-url-in-development' of https://github.com/iamand…
Dec 26, 2019
8e6ea69
resolve conflicts
Dec 30, 2019
1897af7
A few small corrections
Dec 30, 2019
e758178
webpackdevserver quiet setting -> false
Jan 3, 2020
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 4 additions & 0 deletions .alexignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
build

CHANGELOG*
CODE_OF_CONDUCT.md
18 changes: 18 additions & 0 deletions .alexrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"allow": [
"attacks",
"colors",
"conservative",
"crashes",
"executed",
"executes",
"execution",
"failed",
"hook",
"host-hostess",
"hostesses-hosts",
"invalid",
"remain",
"watchman-watchwoman"
]
}
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
packages/ @amyrlam @bugzpodder @gaearon @ianschmitz @iansu @mrmckeb @petetnt @timer
packages/ @ianschmitz @iansu @mrmckeb @petetnt
docusaurus/ @amyrlam @iansu
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Bug report
about: Create a report to help us improve
labels: 'issue: bug'
labels: 'issue: bug report, needs triage'
---

<!--
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/proposal.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
name: Proposal
about: Suggest an idea for improving Create React App
labels: 'issue: proposal'
labels: 'issue: proposal, needs triage'
---

### Is your proposal related to a problem?
Expand Down
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Question
about: Get help with Create React App
labels: 'needs triage'
---

If you have a general question about Create React App or about building an app with Create React App we encourage you to post on our Spectrum community instead of this issue tracker. The maintainers and other community members can provide help and answer your questions there: https://spectrum.chat/create-react-app

If you're looking for general information on using React, the React docs have a list of resources: https://reactjs.org/community/support.html

If you've discovered a bug or would like to propose a change please use one of the other issue templates.

Thanks!
13 changes: 13 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Build

on: [push]

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install
run: yarn --no-progress --non-interactive --no-lockfile
- name: Build
run: yarn build
13 changes: 13 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: Lint

on: [push]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Install
run: yarn --no-progress --non-interactive --no-lockfile
- name: Alex
run: yarn alex
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ yarn-debug.log*
yarn-error.log*
/.changelog
.npm/
yarn.lock
14 changes: 7 additions & 7 deletions CHANGELOG-1.x.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 2.0.3 and Newer Versions

**Please refer to [CHANGELOG.md](./CHANGELOG.md) for the newer versions.**
**Please refer to [CHANGELOG-2.x.md](./CHANGELOG-2.x.md) for the 2.x range, and [CHANGELOG.md](CHANGELOG.md) for the newer versions.**

## 1.1.5 (August 24, 2018)

Expand Down Expand Up @@ -1577,20 +1577,20 @@ Unhandled Promise rejections will now crash tests. You can fix them by explicitl
After the regular update procedure above, add these line to `<head>` in `public/index.html`:

```html
<meta name="theme-color" content="#000000">
<!--
<meta name="theme-color" content="#000000" />
<!--
manifest.json provides metadata used when your web app is added to the
homescreen on Android. See https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/
-->
<link rel="manifest" href="%PUBLIC_URL%/manifest.json">
<link rel="manifest" href="%PUBLIC_URL%/manifest.json" />
```

Add `<noscript>` to `<body>` in `public/index.html`:

```html
<noscript>
You need to enable JavaScript to run this app.
</noscript>
<noscript>
You need to enable JavaScript to run this app.
</noscript>
```

Then create a file called `public/manifest.json` that looks like this:
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG-2.x.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 3.0.0 and Newer Versions

**Please refer to [CHANGELOG.md](./CHANGELOG.md) for the newer versions.**

## 2.1.8 (March 7, 2019)

v2.1.8 is a maintenance release that reapplies the TypeScript speed improvements ([#6406](https://github.com/facebook/create-react-app/pull/6406)) in a new major version of `react-dev-utils`.
Expand Down
651 changes: 651 additions & 0 deletions CHANGELOG.md

Large diffs are not rendered by default.

75 changes: 74 additions & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,76 @@
# Code of Conduct

Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.fb.com/codeofconduct/) so that you can understand what actions will and will not be tolerated.
## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, 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.

## 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 within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
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 at <opensource-conduct@fb.com>. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
33 changes: 22 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Loving Create React App and want to get involved? Thanks! There are plenty of ways you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
Please take a moment to review this document in order to make the contribution process straightforward and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Expand All @@ -15,23 +15,27 @@ Here are a few examples of them in action.

### Convention

<!--alex disable easy-->

Instead of letting the user specify the entry filename, we always assume it to be `src/index.js`. Rather than letting the user specify the output bundle name, we generate it, but make sure to include the content hash in it. Whenever possible, we want to leverage convention to make good choices for the user, especially in cases where it’s easy to misconfigure something.

### Heuristics

Normally, `npm start` runs on port `3000`, and this is not explicitly configurable. However, some environments like cloud IDEs want the programs to run on a specific port to serve their output. We want to play well with different environments, so Create React App reads `PORT` environment variable and prefers it when it is specified. The trick is that we know cloud IDEs already specify it automatically, so there is no need for the user to do anything. Create React App relies on heuristics to do the right thing depending on environment.

<!--alex disable just-->

Another example of this is how `npm test` normally launches the watcher, but if the `CI` environment variable is set, it will run tests once. We know that popular CI environments set this variable, so the user doesn’t need to do anything. It just works.

### Interactivity

We prefer to add interactivity to the command line interface rather than add configuration flags. For example, `npm start` will attempt to run with port `3000` by default, but it may be busy. Many other tools just fail in this case and ask that you pass a different port, but Create React App will display a prompt asking if you’d like to run the app on the next available port.
We prefer to add interactivity to the command line interface rather than add configuration flags. For example, `npm start` will attempt to run with port `3000` by default, but it may be busy. Many other tools fail in this case and ask that you pass a different port, but Create React App will display a prompt asking if you’d like to run the app on the next available port.

Another example of interactivity is `npm test` watcher interface. Instead of asking people to pass command line flags for switching between test runner modes or search patterns, we print a hint with keys that you can press during the test session to instruct watcher what to do. Jest supports both flags and interactive CLI but Create React App prefers long-running sessions to keep user immersed in the flow over short-running sessions with different flags.

### Breaking the Rules

No rules are perfect. Sometimes we may introduce flags or configuration if we believe the value is high enough to justify the mental cost. For example, we know that apps may be hosted paths different from the root, and we need to support this use case. However, we still try to fall back to heuristics when possible. In this example, we ask that you specify `homepage` in `package.json`, and infer the correct path based on it. We also nudge the user to fill out the `homepage` after the build, so the user becomes aware that the feature exists.
No rules are perfect. Sometimes we may introduce flags or configuration if we believe the value is high enough to justify the complexity. For example, we know that apps may be hosted paths different from the root, and we need to support this use case. However, we still try to fall back to heuristics when possible. In this example, we ask that you specify `homepage` in `package.json`, and infer the correct path based on it. We also nudge the user to fill out the `homepage` after the build, so the user becomes aware that the feature exists.

## Submitting a Pull Request

Expand Down Expand Up @@ -76,7 +80,7 @@ This package is enabled by default for all `create-react-app` scaffolded applica

#### [react-dev-utils](https://github.com/facebook/create-react-app/tree/master/packages/react-dev-utils)

This package contains utilities used for `react-scripts` and sister packages.<br>
This package contains utilities used for `react-scripts` and sibling packages.<br>
Its main purpose is to conceal code which the user shouldn't be burdened with upon ejecting.

#### [react-scripts](https://github.com/facebook/create-react-app/tree/master/packages/react-scripts)
Expand All @@ -90,7 +94,7 @@ All functionality must be retained (and configuration given to the user) if they

2. Run `yarn` in the root `create-react-app` folder.

Once it is done, you can modify any file locally and run `yarn start`, `yarn test` or `yarn build` just like in a generated project.
Once it is done, you can modify any file locally and run `yarn start`, `yarn test` or `yarn build` like you can in a generated project.

If you want to try out the end-to-end flow with the global CLI, you can do this too:

Expand All @@ -105,15 +109,15 @@ and then run `yarn start` or `yarn build`.

**TL;DR** use the command `yarn e2e:docker` to run unit and e2e tests.

More detailed information are in the dedicated [README](/packages/react-scripts/fixtures/kitchensink/README.md).
More detailed information are in the dedicated [README](/test/README.md).

### CI testing with private packages

**create-react-app** relies on main registry to fetch all dependencies, but, if you are in the need to usage of custom private packages that need to be fetch while running E2E test you might need a different configuration.

#### Customizing E2E registry configuration

We use [verdaccio](https://github.com/verdaccio/verdaccio) to emulate packages publishing in a registry using a default configuration. You might modify the current behaviour just editing the file `task/verdaccio.yaml`.
We use [verdaccio](https://github.com/verdaccio/verdaccio) to emulate packages publishing in a registry using a default configuration. You might modify the current behaviour by editing the file `task/verdaccio.yaml`.

For more information about the configuration check out the [Verdaccio documentation](https://verdaccio.org/docs/en/configuration).

Expand All @@ -135,8 +139,8 @@ By default git would use `CRLF` line endings which would cause the scripts to fa

## Cutting a Release

1. Tag all merged pull requests that go into the release with the relevant milestone. Each merged PR should also be labeled with one of the [labels](https://github.com/facebook/create-react-app/labels) named `tag: ...` to indicate what kind of change it is.
2. Close the milestone.
1. Tag all merged pull requests that go into the release with the relevant milestone. Each merged PR should also be labeled with one of the [labels](https://github.com/facebook/create-react-app/labels) named `tag: ...` to indicate what kind of change it is. **Make sure all breaking changes are correctly labelled with `tag: breaking change`.**
2. Close the milestone and create a new one for the next release.
3. In most releases, only `react-scripts` needs to be released. If you don’t have any changes to the `packages/create-react-app` folder, you don’t need to bump its version or publish it (the publish script will publish only changed packages).
4. Note that files in `packages/create-react-app` should be modified with extreme caution. Since it’s a global CLI, any version of `create-react-app` (global CLI) including very old ones should work with the latest version of `react-scripts`.
5. Run `yarn compile:lockfile`. The command will generate an updated lockfile in `packages/create-react-app` that should be committed.
Expand All @@ -148,11 +152,18 @@ By default git would use `CRLF` line endings which would cause the scripts to fa
- Maybe add some newlines here and there. Preview the result on GitHub to get a feel for it. Changelog generator output is a bit too terse for my taste, so try to make it visually pleasing and well grouped.

7. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
8. Run `npm run publish`. (It has to be `npm run publish` exactly, not just `npm publish` or `yarn publish`.)
8. Run `npm run publish`. (It has to be `npm run publish` exactly, not `npm publish` or `yarn publish`.)
9. Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
10. After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.

Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- prepatch --canary --preid next --dist-tag next --npm-client npm --force-publish` instead of `npm run publish`.
Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --canary --exact --preid next --dist-tag=next --force-publish=* minor` instead of `npm run publish`.

## Releasing the Docs

1. Go to the `docusaurus/website` directory
2. Run `yarn build`
3. You'll need an [access token for the GitHub API](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Save it to this environment variable: `export GITHUB_AUTH="..."`
4. Run `GIT_USER=<GITHUB_USERNAME> CURRENT_BRANCH=master USE_SSH=true yarn deploy`

---

Expand Down
Loading