Merge pull request #179 from akankshat05/contribution.md

coderwassananmol · web-flow · commit eaf1947d523a · 2023-10-05T18:59:52.000+05:30
Fix CONTRIBUTING.MD
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,17 +1,10 @@
-<<<<<<< HEAD
-Welcome to <b>Book Uploader Bot (BUB)</b> Project. This file demonstrates the contributing guidelines that every developer/mentor has to adhere for GirlScript Summer of Code'20. This is required in order to create a unified development environment. Let's start.
-
-## The Git Workflow
-The workflow that we'll be using is <b> Dev - Staging - Production</b>. All the Pull Request (PR's) will be made to <b>develop</b> branch.
-The mentors shall review the PR. If any change is required in the PR, the mentors shall comment on the PR itself else if
-everything is good, the mentors will merge the PR to the develop branch.<br />
-To read more about this workflow, you can visit [this link](http://guides.beanstalkapp.com/deployments/best-practices.html).
+## Finding issues and new tasks
+- All the issues and tasks are maintained on [Phabricator](https://phabricator.wikimedia.org/maniphest/?project=PHID-PROJ-wnkiea2sihld2xlpq527&statuses=open()&group=none&order=newest#R).
+- Make sure to assign an issue to yourself from [Phabricator](https://phabricator.wikimedia.org/maniphest/?project=PHID-PROJ-wnkiea2sihld2xlpq527&statuses=open()&group=none&order=newest#R) before working on it.
 
 ## Fork
-<b>It is strictly for the participants. Please read it carefully.</b><br />
-Every participant(s) is required to fork this repository and make changes on the forked repository on a new branch other than *develop* and after making all the changes, make a Pull Request to <b>devlop branch</b>.
-
-- After you have the project working on your local machine (refer [README.md](https://github.com/coderwassananmol/BUB2/blob/develop/README.md)), in order to make sure you keep your fork up to date by tracking the original "upstream" repo that you forked. To do this, you'll need to add a remote:
+You are required to fork this repository and make changes on the forked repository on a new branch other than *develop* and after making all the changes, make a Pull Request to <b>develop branch</b>.
+- After you have the project working on your local machine (refer [README.md](https://github.com/coderwassananmol/BUB2/blob/develop/README.md)), make sure you keep your fork up to date by tracking the original "upstream" repo that you forked. To do this, you'll need to add a remote:
     ```
     # Add 'upstream' repo to list of remotes
     $ git remote add upstream https://github.com/coderwassananmol/BUB2.git
@@ -33,56 +26,28 @@ Every participant(s) is required to fork this repository and make changes on the
     # To add all new files to branch Branch_Name
     $ git add .
     ```
-- Commit messages should follow a [certain guideline](https://udacity.github.io/git-styleguide/).To commit give a descriptive message for the convenience of reveiwer by:
+- Commit messages should follow a [certain guideline](https://udacity.github.io/git-styleguide/). To commit, give a descriptive message for the convenience of reveiwer by:
     ```
     # This message get associated with all files you have changed
     $ git commit -m 'message'
     ```
     **NOTE**: A PR should have only one commit. Multiple commits should be squashed.
-- Now you are ready to your work to the remote repository
+- Now you are ready to push your work to the remote repository:
     ```
     # To push your work to your remote repository
     $ git push -u origin Branch_Name
     ```
+## How to raise a pull request
+- Create a Pull Request to merge your branch with the **develop branch** and mention the link to the **Phabricator ticket** you worked on in the description of the Pull Request.
+- Once the Pull Request is open, provide the link to it within the comments section of the respective **Phabricator task**, as illustrated in [this sample](https://phabricator.wikimedia.org/T344119).
 
-Go to your repository in browser and click on compare and pull requests. Then add a title(Please mention the #issue_no you've been working on) and description(link the issue) to your pull request that explains your contribution.
-
-## Issue creation
-<b>It is strictly for the admin and mentors. Please read it carefully. </b><br />
-Mentors and admin are requested to make issues and mark them with GSSoC20 label. Add separate labels like beginner, easy, medium, hard and taken. If a particular issue is assigned to someone mark it as taken. If that person does not respond or show any progress within 2-3 days remove the taken tag.
-
-Please reach out to any of the below mentors for any help. Happy Contributing!
-
-[@coderwassananmol](http://github.com/coderwassananmol) (Project Admin)
-[@ankitjena](https://github.com/ankitjena) (Mentor)
-[@Mohit](https://github.com/mksharma1/) (Mentor)
-[@Parikshit](https://github.com/Parikshit-Hooda) (Mentor)
-[@Ramakrishna](https://github.com/rkpattnaik780) (Mentor)
-[@Rajat](https://github.com/rajat2502) (Mentor)
-[@Sahil](https://github.com/sahilbansal17) (Mentor)
-=======
-## Contribute
-
-#### **Did you find a bug?**
-
-* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/coderwassananmol/BUB2/issues).
-
-* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/coderwassananmol/BUB2/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+## Code Reviews
+- All submissions should come in the form of a PR and it must be reviewed by at least one reviewer before it gets merged.
 
-#### **Did you write a patch that fixes a bug?**
+## Did you find a bug?
 
-* Open a new GitHub [pull request] (https://github.com/coderwassananmol/BUB2/compare) with the patch.
+* **Ensure the bug was not already reported** by searching on [Phabricator](https://phabricator.wikimedia.org/maniphest/?project=PHID-PROJ-wnkiea2sihld2xlpq527&statuses=open()&group=none&order=newest#R).
 
-* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+* If the bug is not already reported, create a **New Bug Report**. Make sure to include **title, clear description, tags**, and as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
 
-### Pull Request Process
 
-* Fork the [repo](https://github.com/coderwassananmol/BUB2/issues)
-* Clone your forked copy 
-* Add the [repo](https://github.com/coderwassananmol/BUB2.git) as remote upstream.
-* Follow the [setup instructions](https://github.com/coderwassananmol/BUB2#local-setup-instructions) to get your local copy working.
-* Make changes as appropriate. 
-* Pull updates from remote upstream.
-* Push your changes to your forked repository.
-* Make a PR with your updates.
->>>>>>> b58bfed757c1097c0ac3074ad4e11dae6f897717
