Skip to content

Commit ed95f3f

Browse files
committed
🎄 docs: enhance CONTRIBUTING.md structure and wording
1 parent a41f337 commit ed95f3f

File tree

1 file changed

+39
-13
lines changed

1 file changed

+39
-13
lines changed

‎CONTRIBUTING.md

+39-13
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,80 @@
1-
# How to contribute to flaskcwg.github.io
1+
# Contributing to `flaskcwg.github.io`
22

33
## Setup Instructions
44

5-
* [Fork](https://github.com/flaskcwg/flaskcwg.github.io/fork) the repo
6-
* Clone your forked repo
5+
### 1. **Fork the Repository**
6+
- Navigate to the [repository's fork page](https://github.com/flaskcwg/flaskcwg.github.io/fork).
7+
- Click the "Fork" button to create a copy of the repository under your GitHub account.
8+
9+
### 2. **Clone Your Forked Repository**
10+
- Clone your fork to your local machine:
711

812
```bash
9-
git https://github.com/{username}/flaskcwg.github.io.git
13+
git clone https://github.com/{username}/flaskcwg.github.io.git
1014
cd flaskcwg.github.io
1115
```
1216

13-
* Setup the upstream to original repo
17+
### 3. **Set Up the Upstream Remote**
18+
- Add the original repository as an upstream remote to keep your fork synchronized:
1419

1520
```bash
1621
git remote add upstream https://github.com/flaskcwg/flaskcwg.github.io.git
1722
```
1823

19-
* Create a virtual env and activate it
20-
21-
For Linux/Mac:
24+
### 4. **Create and Activate a Virtual Environment**
25+
- **For Linux/Mac**:
2226

2327
```bash
2428
python -m venv env
2529
source env/bin/activate
2630
```
2731

28-
For Windows:
32+
- **For Windows**:
2933

3034
```bash
3135
py -m venv env
3236
source env\Scripts\activate
3337
```
3438

35-
* install dependencies
39+
### 5. **Install Dependencies**
40+
- Install the required Python dependencies:
3641

3742
```bash
3843
pip install -r requirements.txt
3944
```
4045

41-
* run `static.py`. This will build html content in `docs/`
46+
### 6. **Build the Static HTML Content**
47+
- Run the `static.py` script to generate the HTML content in the `docs/` directory:
4248

4349
```bash
4450
python static.py
4551
```
4652

47-
* run `serve.py`. Go to the IP address shown in the printout to view the generated site
53+
### 7. **Serve the Generated Site**
54+
- Serve the generated content locally by running the `serve.py` script:
4855

4956
```bash
5057
cd docs
5158
python serve.py
5259
```
5360

54-
* Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote "fork", the default Pallets remote is "origin".
61+
- Access the site using the IP address displayed in the console output.
62+
63+
### 8. **Push Your Changes to Your Fork**
64+
- Add your fork as a remote to push your contributions. Replace `{username}` with your GitHub username. This step names your forked repository remote as `fork` while retaining `origin` for the original repository:
65+
66+
```bash
67+
git remote add fork https://github.com/{username}/flaskcwg.github.io.git
68+
```
69+
70+
---
71+
72+
### Notes:
73+
- Ensure your fork is updated with the upstream repository before starting new work by running:
74+
```bash
75+
git fetch upstream
76+
git merge upstream/main
77+
```
78+
- Submit your contributions via a pull request after committing your changes to your forked repository.
79+
80+
By following these instructions, you'll be able to set up your environment and contribute effectively. Happy coding! 🎉

0 commit comments

Comments
 (0)