You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+9-46Lines changed: 9 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,46 +10,11 @@ If you're looking for ideas about what to work on, check out:
10
10
11
11
- Our [issues](https://github.com/CodeChefVIT/papers-codechef/issues) based on votes by the community.
12
12
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.
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.
34
14
35
15
---
36
16
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.
-**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).
Once your environment is set up, you're ready to start coding.
68
31
@@ -85,16 +48,12 @@ Once your environment is set up, you're ready to start coding.
85
48
86
49
---
87
50
88
-
### 6. Submit a Pull Request
51
+
### Submit a Pull Request
89
52
90
53
-**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.
-**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.
99
58
100
59
---
@@ -104,12 +63,16 @@ Once your environment is set up, you're ready to start coding.
104
63
Please ensure that any PR you make contains these things -
105
64
106
65
- 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).
108
67
- List the major changes made in this PR.
109
68
- Mention any bug fixes, known issues, or follow-ups needed.
110
69
111
70
**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.
112
71
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
+
113
76
## Tips to improve the chances of your PR getting reviewed and merged
114
77
115
78
- Small, focused, incremental pull requests are much easier to review
0 commit comments