changed contributing.md

Author: Advik-Gupta

CONTRIBUTING.md

@@ -1,72 +1,70 @@
-## Contribution Guidelines
+### **How to Contribute to the Papers Repository**
 
-Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+We appreciate your interest in contributing to the `papers-codechef` repository! Please follow these guidelines to ensure a smooth and effective contribution process.
 
-## How to contribute
+---
 
-- Decide which repository to contribute
-- Decide what to contribute
-- Fork the repo then clone it locally
-- Commit your work (You should create a new branch when you're doing development work that is somewhat experimental in nature.)
-- Create a **Pull Request**
-- Congrats 🎉 you have just contributed towards open source!
+### **1. Get an Issue Assigned**
 
-## What to contribute
+All contributions must be tied to an issue. Go to the issues page at `https://github.com/CodeChefVIT/papers-codechef/issues`
+You can either ask a board member to assign you an existing issue or create a new issue and ask a board member to assign it to you.
 
-- Find an open issue to tackle
-- Ask if you can help write a new feature
-- Add / Improve Unit Testing
-- Write tutorials for how a project can be used and add to the readme
-- Review code on other people’s submissions and help improving / finding vulnerabilities
+---
 
-## Making a PR
-- Provide all the appropriate details asked in PR template
-- A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later.
+### **2. Fork the Repository**
 
-## Opening an Issue
-- Make use of an appropriate Issue Template
-- We welcome Feature request, Bug Report, Documentation fix and others
-- Do not open critical security issues here, report them directly at [our email](mailto:contact@codechefvit.com).
+To start working, you need to create your own copy of the repository.
 
-## Communicating effectively
-**Give context.** Help others get quickly up to speed. If you’re running into an error, explain what you’re trying to do and how to reproduce it. If you’re suggesting a new idea, explain why you think it’d be useful to the project (not just to you!).
+- **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.
+- **Create the fork:** When prompted, make sure the "Copy the `prod` branch only" option is unchecked.
 
-```
-✔️ “X doesn’t happen when I do Y”
-❌ “X is broken! Please fix it.”
-```
+---
 
-**Do your homework beforehand.** It’s OK not to know things, but show that you tried. Before asking for help, be sure to check a project’s README, documentation, issues (open or closed), mailing list, and search the internet for an answer. People will appreciate when you demonstrate that you’re trying to learn.
+### **3. Clone Your Fork**
 
-```
-✔️ ““I’m not sure how to implement X. I checked the help docs and didn’t find any mentions.””
-❌ “How do I X?”
-```
+After forking, you need to get the code onto your local machine.
 
-**Keep requests short and direct.**
+- **Clone the repo:** Copy the URL of your fork to your clipboard.
+- **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.
+- **Sync your fork:** Before you start, make sure your fork is up to date with the original `CodeChefVIT` repository.
 
-```
-✔️ “I’d like to write an API tutorial.”
-❌ “I was driving down the highway the other day and stopped for gas, and then I had this amazing idea for something we should be doing, but before I explain that, let me show you…“
-```
+---
 
-**It’s okay to ask questions (but be patient!).**
+### **4. Set Up Your Local Environment**
 
-```
-✔️ “Thanks for looking into this error. I followed your suggestions. Here’s the output.”
-❌ “Why can’t you fix my problem? Isn’t this your project?”
-```
+To get the project running, you'll need to set up your local environment.
 
-**Respect community decisions.**
+- **Create a `.env` file:** Create a new file named `.env` and ask a board member for its contents.
+- **Install dependencies:** Run `pnpm i` in your terminal to install all necessary dependencies.
+- **Run the project:** Run `pnpm dev` to start the project.
 
-```
-✔️ “I’m disappointed you can’t support my use case, but as you’ve explained it only affects a minor portion of users, I understand why. Thanks for listening.”
-❌ “Why won’t you support my use case? This is unacceptable!”
-```
+---
 
-## Misc
-- You are welcome to Propose a new feature by creating an **Issue**.
-- You may Discuss a high-level topic or idea (for example, community, vision or policies) by writing to us at our [Email](mailto:contact@codechefvit.com).
+### **5. Work on Your Code**
 
-## Attribution
-- [Open Source Guide](https://opensource.guide/how-to-contribute/)
+Once your environment is set up, you're ready to start coding.
+
+- **Create a new branch:** Use the command `git checkout -b yourName/featureName` to create a new branch for your work.
+- **Make your changes:** Write the code to address the issue you were assigned.
+- **Add changed files:** After making your changes, use `git add` to add the modified files to Git tracking.
+- **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:
+  - `feat:` A new feature.
+  - `fix:` A bug fix.
+  - `docs:` Documentation changes.
+  - `style:` Formatting or white-space changes that do not affect the code's meaning.
+  - `refactor:` A code change that is not a bug fix or a new feature.
+  - `perf:` A code change that improves performance.
+  - `test:` Adding or correcting tests.
+  - `build:` Changes affecting the build system or external dependencies.
+  - `ci:` Changes to CI configuration files or scripts.
+  - `chore:` Other changes that don't modify source or test files.
+  - `revert:` Reverts a previous commit.
+- **Push your changes:** Push your commits to your forked repository using `git push`.
+
+---
+
+### **6. Submit a Pull Request**
+
+- **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.
+- **Target the `staging` branch:** When creating the pull request, make sure you set the **base branch** to `staging`.
+- **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.