Skip to content

Commit 4632005

Browse files
authored
Update CONTRIBUTING.md
1 parent 7064aca commit 4632005

1 file changed

Lines changed: 20 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,27 @@ You can either ask a board member to assign you an existing issue or create a ne
1616
To start working, you need to create your own copy of the repository.
1717

1818
- **Fork the repo:** Navigate to `https://github.com/CodeChefVIT/papers-codechef` and click the "Fork" button to create a copy of the repository on your account. This allows you to freely experiment with changes without affecting the original project.
19+
20+
<img width="1480" height="327" alt="image" src="https://github.com/user-attachments/assets/3df5e7e3-ebad-4598-b51f-0fa64f0f1cca" />
21+
1922
- **Create the fork:** When prompted, make sure the "Copy the `prod` branch only" option is unchecked.
23+
24+
<img width="1376" height="685" alt="image" src="https://github.com/user-attachments/assets/035dc07b-3296-4706-8037-f03de90fdafb" />
2025

2126
---
2227

2328
### **3. Clone Your Fork**
2429

2530
After forking, you need to get the code onto your local machine.
2631

32+
- **Sync your fork:** Before you start, make sure your fork is up to date with the original `CodeChefVIT` repository.
33+
34+
<img width="1486" height="1025" alt="image" src="https://github.com/user-attachments/assets/61a1fb0d-9000-49c0-be8a-7fccce966963" />
35+
2736
- **Clone the repo:** Copy the URL of your fork to your clipboard.
2837
- **Run `git clone {url}`:** This command will clone the repository. You can use either **HTTPS** (less secure, easier) or **SSH** (more secure, needs a `.ssh` file setup). If you're unsure which method to use, ask a board member for help.
29-
- **Sync your fork:** Before you start, make sure your fork is up to date with the original `CodeChefVIT` repository.
38+
39+
<img width="1490" height="1045" alt="image" src="https://github.com/user-attachments/assets/49ff2344-25b1-49d2-bb96-8a9581b0c73a" />
3040

3141
---
3242

@@ -36,8 +46,11 @@ To get the project running, you'll need to set up your local environment.
3646

3747
- **Create a `.env` file:** Create a new file named `.env` and ask a board member for its contents.
3848
- **Install dependencies:** Run `pnpm i` in your terminal to install all necessary dependencies.
49+
- **Do git checkout staging** if you want to contribute during a major revamp that is going on. Ask a board which branch to take as a base, if unsure.
3950
- **Run the project:** Run `pnpm dev` to start the project.
4051

52+
<img width="1600" height="969" alt="image" src="https://github.com/user-attachments/assets/74ef04d2-fb5e-4b80-b014-f9207fc01714" />
53+
4154
---
4255

4356
### **5. Work on Your Code**
@@ -66,5 +79,11 @@ Once your environment is set up, you're ready to start coding.
6679
### **6. Submit a Pull Request**
6780

6881
- **Open a Pull Request:** On your GitHub page for the forked repository, you will see a button to "Open pull request" since your branch is ahead of the upstream. Click this to begin the process.
82+
83+
<img width="1482" height="1052" alt="image" src="https://github.com/user-attachments/assets/b72f3735-5801-496b-a59b-6f184c39eaa6" />
84+
6985
- **Target the `staging` branch:** When creating the pull request, make sure you set the **base branch** to `staging`.
86+
87+
<img width="1482" height="1052" alt="image" src="https://github.com/user-attachments/assets/7578cf06-160e-4965-9273-5b68e926911d" />
88+
7089
- **Request a review:** After creating the pull request, direct message a board member to review your PR. Any new changes you push to your branch will be automatically attached to the pull request.

0 commit comments

Comments
 (0)