Skip to content

Commit 6f0aaa9

Browse files
authored
Update README.md
Added contribution details to readme.md.
1 parent a22ad61 commit 6f0aaa9

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# BattlezoneScrapField.github.io
2-
Root GitHub Organization website
1+
2+
# Welcome to the Battlezone Scrap Field! πŸ‘‹
3+
4+
We are a community-managed organization that aims to provide a one-stop shop for Battlezone community members to share their open-source resources or projects.
5+
Feel free to get involved, fork your projects, or create new project repositories here!
6+
Let any of the members know if you have any questions, feedback, or want to help contribute!
7+
8+
<p align="center">
9+
<img width="50%" src="https://raw.githubusercontent.com/BattlezoneScrapField/.github/refs/heads/main/profile/gif/bz2_scav_deploy.gif">
10+
</p>
11+
12+
<br>
13+
14+
## Getting Started πŸš€
15+
We'd be happy to have you contribute to this website! Here's how you can contribute:
16+
17+
### Local Environment
18+
- Clone this repo to your local pc.
19+
- Open up `index.html` in your web browser to preview the site.
20+
21+
### Pushing Changes
22+
> Note: the branching process looks like: `your-dev-branch β†’ master β†’ prod`
23+
24+
- Commit your changes to a **new** branch, sourced from `master`. You may call your branch whatever you like (i.e., `"dev-john-cooke"`).
25+
- Create a **Pull Request** to the `master` branch from your newly developed branch. Make sure to give it an adequate title, description, and label!
26+
- Now, sit back and relax! πŸ–οΈ _From here: a code reviewer will review your commits and changes to complete the merge. If your changes look great, your PR to `master` will be approved, which means your new branch `"dev-john-cooke"` will be squashed. A member of the team will create a new PR to merge your changes (that are now in `master`) into `prod`. This will trigger the automated deployment to GitHub Pages!_
27+
28+
## Credits πŸ›Ή
29+
- Website created and setup by [SirBrambley](https://github.com/LordBramster), and maintained by the Battlezone Community. πŸ’–
30+

0 commit comments

Comments
Β (0)