Skip to content

Commit aef1f54

Browse files
authored
updates copy to reflect master -> main
1 parent d3b1767 commit aef1f54

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ What's this? This is a template repository that sets up a few minor systems for
1212
* has Netlify redirects set up for multi-route SPAs
1313
* includes the [Contributor Covenant](https://www.contributor-covenant.org/) in `CODE_OF_CONDUCT.md`
1414
* has a little bit of documentation for new people!
15+
* uses `main` as the default branch (new)
1516

1617
We are also planning on creating a more opinionated starter (with `react-router-dom`, stricter ESLint checks, auto-formatting, and fonts) soon! Keep an eye out for that!
1718

@@ -28,7 +29,7 @@ Things you should do **after using this as a template**:
2829
- [ ] find-and-replace `YOUR_PROJECT_URL_HERE` with your GitHub repo's project name in this README (it's in a few places, so use an editor!)
2930
- [ ] set up [Netlify](https://www.netlify.com/) for this app - talk to matt (@malsf21) or leo (@krashanoff) if you need access to the Teach LA Netlify team
3031
- [ ] turn on "Automatically delete head branches" in GitHub `Settings > Options`
31-
- [ ] in `Settings > Branches`, create a branch protection rule that requires PR reviews. You can optionally enable status checks.
32+
- [ ] in `Settings > Branches`, create a branch protection rule for `main` that requires PR reviews. You can optionally enable status checks, like passing `build`.
3233
- [ ] update the README badges for the GitHub Actions and Netlify with the correct links!
3334
- [ ] update and delete this documentation!
3435

@@ -60,13 +61,13 @@ npm run build
6061

6162
Want to make a change? Great! Here are the steps:
6263

63-
1. Either make a new branch or a fork of this repository. `master` is a protected branch, **so you cannot push to it**.
64+
1. Either make a new branch or a fork of this repository. `main` is a protected branch, **so you cannot push to it**.
6465
2. Follow the instructions in "Development Setup" above. If you're on a fork, replace the URL with the fork's URL; if you're on a different branch, check it out using `git checkout`.
6566
3. Make your changes!
6667
4. **Before you push**, make sure your app builds with `npm run build`. If there are any errors, our CI/CD service will **reject your build**.
6768
5. Once you're ready, stage and commit your changes!
6869
6. Make a [pull request](https://github.com/uclaacm/YOUR_PROJECT_URL_HERE/pulls) with your changes, and let someone on the dev team know. Netlify has a neat feature called "Deploy Previews" that give you a link to preview your changes; [see the blog post](https://www.netlify.com/blog/2016/07/20/introducing-deploy-previews-in-netlify/) for more info!
69-
7. If your code passes code review, we'll merge it into `master`. Congratulations! If you'd like, it's now safe to delete your branch/fork.
70+
7. If your code passes code review, we'll merge it into `main`. Congratulations! If you'd like, it's now safe to delete your branch/fork.
7071

7172
## Licensing & Attribution
7273

0 commit comments

Comments
 (0)