Skip to content

Commit c0e4a58

Browse files
committed
made contributor md more concise
1 parent bb5cb55 commit c0e4a58

1 file changed

Lines changed: 9 additions & 46 deletions

File tree

CONTRIBUTING.md

Lines changed: 9 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,11 @@ If you're looking for ideas about what to work on, check out:
1010

1111
- Our [issues](https://github.com/CodeChefVIT/papers-codechef/issues) based on votes by the community.
1212

13-
---
14-
15-
## How to Contribute
16-
17-
### 1. Get an Issue Assigned
18-
19-
To start working on an issue you self assign yourself to the issue, and make sure you mention the issue you are solving in the PR you make
20-
21-
---
22-
23-
### 2. Fork the Repository
24-
25-
To start working, you need to create your own copy of the repository.
26-
27-
- **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.
28-
29-
<img width="1480" height="327" alt="image" src="https://github.com/user-attachments/assets/3df5e7e3-ebad-4598-b51f-0fa64f0f1cca" />
30-
31-
- **Create the fork:** When prompted, make sure the "Copy the `prod` branch only" option is unchecked.
32-
33-
<img width="1376" height="685" alt="image" src="https://github.com/user-attachments/assets/035dc07b-3296-4706-8037-f03de90fdafb" />
13+
The best way to propose a change is to start a discussion on our CodeChefVIT GitHub repository. Begin by writing a brief problem statement that clearly explains the issue you want to address, without tying it to any specific solution. It doesn’t need to be long or formal — just make sure it provides enough context to understand the problem before discussing possible solutions.
3414

3515
---
3616

37-
### 3. Clone Your Fork
38-
39-
After forking, you need to get the code onto your local machine.
40-
41-
- **Sync your fork:** Before you start, make sure your fork is up to date with the original `CodeChefVIT` repository.
42-
43-
<img width="1486" height="1025" alt="image" src="https://github.com/user-attachments/assets/61a1fb0d-9000-49c0-be8a-7fccce966963" />
44-
45-
- **Clone the repo:** Copy the URL of your fork to your clipboard.
46-
- **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).
47-
48-
<img width="1490" height="1045" alt="image" src="https://github.com/user-attachments/assets/49ff2344-25b1-49d2-bb96-8a9581b0c73a" />
49-
50-
---
51-
52-
### 4. Set Up Your Local Environment
17+
### Set Up Your Local Environment
5318

5419
To get the project running, you'll need to set up your local environment.
5520

@@ -58,11 +23,9 @@ To get the project running, you'll need to set up your local environment.
5823
- **Do git checkout staging** if you want to contribute during a major revamp that is going on.
5924
- **Run the project:** Run `pnpm dev` to start the project.
6025

61-
<img width="1600" height="969" alt="image" src="https://github.com/user-attachments/assets/74ef04d2-fb5e-4b80-b014-f9207fc01714" />
62-
6326
---
6427

65-
### 5. Work on Your Code
28+
## How to Contribute
6629

6730
Once your environment is set up, you're ready to start coding.
6831

@@ -85,16 +48,12 @@ Once your environment is set up, you're ready to start coding.
8548

8649
---
8750

88-
### 6. Submit a Pull Request
51+
### Submit a Pull Request
8952

9053
- **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.
9154

92-
<img width="1482" height="1052" alt="image" src="https://github.com/user-attachments/assets/b72f3735-5801-496b-a59b-6f184c39eaa6" />
93-
9455
- **Target the `staging` branch:** When creating the pull request, make sure you set the **base branch** to `staging`.
9556

96-
<img width="1482" height="1052" alt="image" src="https://github.com/user-attachments/assets/7578cf06-160e-4965-9273-5b68e926911d" />
97-
9857
- **Request a review:** After creating the pull request, wait for a organization member to review your PR. Any new changes you push to your branch will be automatically attached to the pull request.
9958

10059
---
@@ -104,12 +63,16 @@ Once your environment is set up, you're ready to start coding.
10463
Please ensure that any PR you make contains these things -
10564

10665
- Purpose and issue which the PR is made regarding.
107-
- Showcase the changes made by attaching screenshots of the visual changes done.
66+
- Before & after screenshots if your changes involve any visual adjustments (e.g. UI changes, layout tweaks).
10867
- List the major changes made in this PR.
10968
- Mention any bug fixes, known issues, or follow-ups needed.
11069

11170
**Important:** Make sure there are no merge conflicts with the branch while making a PR otherwise it will not be merged, run `pnpm build` before making a PR to ensure there are no build errors while merging as well.
11271

72+
**AI Disclosure:** Disclosure of any AI assistance used while working on the PR. Clearly state the extent of AI involvement (for example, “used AI for documentation only” or “used AI to generate initial code”). If the PR descriptions or responses are generated by AI, that must also be disclosed.
73+
74+
**Note:** Trivial tab-completion (like single keywords or short phrases) does not need to be disclosed.
75+
11376
## Tips to improve the chances of your PR getting reviewed and merged
11477

11578
- Small, focused, incremental pull requests are much easier to review

0 commit comments

Comments
 (0)