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
+8-20Lines changed: 8 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,11 @@
3
3
We appreciate your interest in contributing to the `papers-codechef` repository! Please follow these guidelines to ensure a smooth and effective contribution process.
4
4
5
5
6
-
## Contribution ideas
6
+
## Getting started
7
7
8
-
If you're looking for ideas about what to work on, check out:
The best way to propose a change is to start a [discussion](https://github.com/CodeChefVIT/papers-codechef/discussions) on our CodeChefVIT GitHub repository. Begin by creating a new discussion, write 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 provide enough context to clearly understand the problem before discussing possible solutions.
8
+
- If you're looking for ideas about what to work on, check out our [issues](https://github.com/CodeChefVIT/papers-codechef/issues)
9
+
- If you have a bugfix to report ensure that you are on the latest pkull and no similar issue exists. You can then [create an bug report](https://github.com/CodeChefVIT/papers-codechef/issues/new?template=bug_report.md)
10
+
- You can also propose a [feature request]([https://github.com/CodeChefVIT/papers-codechef/issues](https://github.com/CodeChefVIT/papers-codechef/issues/new?template=feature_request.md)). Begin by filling out the template, write 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 provide enough context to clearly understand the problem before discussing possible solutions.
13
11
14
12
## Setting up
15
13
-**Fork** the repository. All the PRs would be made from this fork.
@@ -29,24 +27,14 @@ Once your environment is set up, you're ready to start coding.
29
27
-**Create a new branch:** Use the command `git checkout -b yourName/featureName` to create a new branch for your work.
30
28
-**Make your changes:** Write the code to address the issue you were assigned.
31
29
-**Add changed files:** After making your changes, use `git add .` to add the modified files to Git tracking.
32
-
-**Commit your changes:** Use `git commit -m "feat: xyz"` to create a checkpoint for your work. Use a prefix that describes your changes. Common prefixes include:
33
-
-`feat:` A new feature.
34
-
-`fix:` A bug fix.
35
-
-`docs:` Documentation changes.
36
-
-`style:` Formatting or white-space changes that do not affect the code's meaning.
37
-
-`refactor:` A code change that is not a bug fix or a new feature.
38
-
-`perf:` A code change that improves performance.
39
-
-`test:` Adding or correcting tests.
40
-
-`build:` Changes affecting the build system or external dependencies.
41
-
-`ci:` Changes to CI configuration files or scripts.
42
-
-`chore:` Other changes that don't modify source or test files.
43
-
-`revert:` Reverts a previous commit.
30
+
-**Commit your changes:** Please follow standard conventional commit guidelines as outlined here: https://www.conventionalcommits.org/en/v1.0.0/
44
31
-**Push your changes:** Push your commits to your forked repository using `git push`.
45
32
46
33
## Submit a Pull Request
47
34
48
-
-**Open a Pull Request:** On the forked repository, open a pull request and set the **base branch** to `staging` to submit your changes for review.
49
-
-**Request a review:** Wait for a organization member to review your PR. Any new changes you push to your branch will be automatically attached to the PR.
35
+
-**[Submit your pull request](https://github.com/CodeChefVIT/papers-codechef/compare):** Please, fill in the Pull Request template - it will help us better understand the PR and increase the chances of it getting merged quickly.
36
+
37
+
An organization member will review the PR and discuss changes you might have to make before merging it. Any new changes you push to your branch will be automatically attached to the PR.
0 commit comments