Skip to content

Commit 0a1833f

Browse files
committed
Add Deployment badge to README.md.
1 parent c9978f3 commit 0a1833f

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

+9-8
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Women Who Code Front End Study Group Project
22

3+
[![Build & Deploy React App](https://github.com/frontendstudygroup/frontendstudygroup.github.io/actions/workflows/ci-build.yml/badge.svg)](https://github.com/frontendstudygroup/frontendstudygroup.github.io/actions/workflows/ci-build.yml)
4+
35
This repository is a beginner-friendly project started by [Women Who Code Front End](https://www.womenwhocode.com/frontend) to learn about front end technologies as well as how to collaborate on an open source project.
46

57
Currently it is deployed at [https://frontendstudygroup.github.io](https://frontendstudygroup.github.io) using [GitHub Pages](https://pages.github.com/).
@@ -20,11 +22,14 @@ Participation and maintenance of this project is completely voluntary and we are
2022
- Search in [Issues](https://github.com/frontendstudygroup/frontendstudygroup.github.io/issues) for open issues to work on
2123
- If you would like to make a suggestion for an enhancement, or report a defect, create an issue
2224
- Fork the repository (recommended if you are doing this for the first time)
23-
- Clone your forked repository to your pc ( git clone "url from clone option.)
24-
- Assign the issue to yourself
25+
- Clone your forked repository to your machine (`git clone [url from clone option]`)
26+
- Request to assign the issue for yourself
2527
- Comment on the issue about your approach to solving the problem
2628
- Get feedback from other contributors or project maintainers
2729
- Submit a pull request when you are ready
30+
- Add a title and small description in the pull request about what you did.
31+
- Make sure to reference the issue number in the pull request comment with the words _"Fixes #[issue number]"_ or _"Resolves #[issue number]"_ as explained in [GitHub documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
32+
2833

2934
Questions about front end? [Join the WWC Front End Slack](https://join.slack.com/t/womenwhocodefrontend/shared_invite/zt-gaic5y90-pDJK4H_NbObZ_MU_rcYc0A) and join the `#fe-beginner-studygroup` channel.
3035

@@ -50,13 +55,9 @@ See the section about [running tests](https://facebook.github.io/create-react-ap
5055

5156
### Deployment
5257

53-
Executing the command `npm run build` builds the app for production to the `build` folder.
54-
It correctly bundles React in production mode and optimizes the build for the best performance.
55-
56-
The build is minified and the filenames include the hashes.
57-
Your app is ready to be deployed!
58+
There is a GitHub action set up on this repository to build the React app, run tests and deploy to the GitHub Pages site on every merge to the `master` branch.
5859

59-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) in the Create React App documentation for more information.
60+
Also when a pull request is created or updated, the GitHub action will build the React app and run tests. If the build or tests fail, the pull request will be blocked from merging until they are resolved.
6061

6162
### Learn More
6263

0 commit comments

Comments
 (0)