Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
RahulKhanna14 authored Apr 16, 2024
1 parent b1719a8 commit 45c66fd
Showing 1 changed file with 27 additions and 7 deletions.
34 changes: 27 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,33 @@ npm run build

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

1. Either make a new branch or a fork of this repository. `master` is a protected branch, **so you cannot push to it**.
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`.
3. Make your changes!
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**.
5. Once you're ready, stage and commit your changes!
6. Make a [pull request](https://github.com/uclaacm/bias-by-us/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!
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.
1. Make sure your main branch is updated with other peoples' changes.
```
git checkout main
git pull
```
2. Make a new branch of this repository. `main` is a protected branch, **so you cannot push to it**.
a. For branch naming, follow this convention: `<issue-number>_<change-you-made>` (e.g. `43_animate_checkmark`).
```
git checkout -b <your-branch-name>
```
3. Implement your code changes for your feature: Beep boop away! Before pushing, make sure that your app builds with 'npm run build', without any errors.
4. Update your local branch with changes from main branch.
```
git merge main
```
5. Once you're ready, stage and commit your changes.
```
git commit -am <your-message>
```
6. Move your local branch changes to remote repository.
```
git push --set-upstream origin <your-branch-name>
```
7. Make a pull request with your changes, and let someone on your project team know.
a. 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!
8. If your code passes code review, then we can **squash and merge** it into `main`. Congratulations! If you'd like, it's now safe to delete your branch.


## Licensing & Attribution

Expand Down

0 comments on commit 45c66fd

Please sign in to comment.