Skip to content

Commit 635116b

Browse files
Update CONTRIBUTING.md
1 parent af3ab94 commit 635116b

1 file changed

Lines changed: 1 addition & 9 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
We appreciate your interest in contributing to the `papers-codechef` repository! Please follow these guidelines to ensure a smooth and effective contribution process.
44

5-
---
65

76
## Contribution ideas
87

@@ -12,22 +11,17 @@ If you're looking for ideas about what to work on, check out:
1211

1312
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.
1413

15-
---
16-
### Cloning the repository
14+
## Setting up
1715
- **Fork** the repository. All the PRs would be made from this fork.
1816
- **Clone** the repository.
1917

20-
### Set Up Your Local Environment
21-
2218
To get the project running, you need to set up your local environment:
2319

2420
- **Create a `.env` file:** Create a new file named `.env` and use the .env.example file to create your own .env file and put in your your own environment variables to make the project functional.
2521
- **Install dependencies:** Run `pnpm i` in your terminal to install all necessary dependencies.
2622
- **Checkout staging branch**: Run `git checkout staging` to switch branches.
2723
- **Run the project:** Run `pnpm dev` to start the project.
2824

29-
---
30-
3125
## How to Contribute
3226

3327
Once your environment is set up, you're ready to start coding.
@@ -49,8 +43,6 @@ Once your environment is set up, you're ready to start coding.
4943
- `revert:` Reverts a previous commit.
5044
- **Push your changes:** Push your commits to your forked repository using `git push`.
5145

52-
---
53-
5446
## Submit a Pull Request
5547

5648
- **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.

0 commit comments

Comments
 (0)