README.md: Update development workflow

README.md

@@ -1,6 +1,8 @@
 # Programming Club UIET #
 This is the official website of the Programming Club at UIET, Panjab University. ![Loading Badge Failed](https://travis-ci.org/pclubuiet/website.svg?branch=master)
-## Setting up your Development Environment ##
+## Development Workflow ##
+
+### Setup your development environment ###
 1. Fork this repository to your account.
 
 2. Create a virtual environment on your machine. 
@@ -43,14 +45,15 @@ This is the official website of the Programming Club at UIET, Panjab University.
     ```
     git remote add myfork https://github.com/<username>/website.git
     ```
-
-9. Find an issue in this repository that you would like to and can fix.
-   Start working on an issue. Steps 10 and beyond will guide you in doing this.
+## Fixing issues ##
+### Step 1: Pick an issue ###
+After selecting an issue
+1. Comment on the issue saying that you are working on the issue.
+2. We expect you to discuss the approach by comments.
+3. Updates or progress on the issue would be nice.
 
-   **In case multiple people are working on the same issue, the Pull Request that is completed first shall be given**
-   **the highest preference. The reviews will be on a first come first service basis.**   
-
-10. Create a new branch and switch to it (make sure you are on master before doing this).
+### Step 2: Follow branch policies ###
+1. Create a new branch and switch to it (make sure you are on master before doing this).
     ```
     git branch mybranch
     git checkout mybranch
@@ -61,7 +64,7 @@ This is the official website of the Programming Club at UIET, Panjab University.
     git checkout -b mybranch
     ```
 
-11. Make your changes and then execute the tests to make sure you didn't break anything.
+2. Make your changes and then execute the tests to make sure you didn't break anything.
 
     ```
     python3 manage.py test
@@ -73,25 +76,34 @@ This is the official website of the Programming Club at UIET, Panjab University.
 
     *A small description of your changes is must in the commit messages.* 
 
-12. After you are done making changes, push the branch to your fork.
+3. After you are done making changes, push the branch to your fork.
     ```
     git push -u myfork mybranch
     ```
     The **-u** option is required only the first time you push the branch.
-	In case you have made multiple commits, you need to squash them into a single commit before pushing.
 
-13. Then create a Pull Request from that branch using GitHub.
+ Make sure your branch is up-to-date with the latest version of the master. Else you are required to do a rebase to place your changes above master branch.
 
-**What happens after you have submitted a Pull Request?**
+### Step 3: Follow Coding policy
 
-Well, you could wait for it to be reviewed by someone or you could attempt to fix another issue. 
+ 1. Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.
+ 2. Single commit per pull request
+ 3. For writing commit messages please adhere to the Commit style guidelines.
+ 4. Follow uniform design practices.
+ 5. The pull request will not get merged until and unless the commits are squashed. In case there are multiple commits on the PR, the commit author needs to squash them and not the maintainers cherrypicking and merging squashes.
+ 6. If the PR is related to any front end change, please attach relevant screenshots in the pull request description
+o
+### Step 4: Submitting a Pull request ###
+Once a PR is opened, try and complete it within 2 weeks, or at least stay actively working on it. Inactivity for a long period may necessitate a closure of the PR. As mentioned earlier updates would be nice.
 
-*OR*
+### Step 5: Code Review ###
 
-You could help us in an even better way! 
+Your code will be reviewed, in this sequence, by:
 
+1. Travis CI: by building and running tests. If there are failed tests, the build will be marked as a failure. You can consult the CI log to find which tests. Ensure that all tests pass before triggering another build.
+2. Reviewer: A core team member will review your pull request and approve it or he will suggest changes.
 
-### Help us by reviewing other Pull Requests! ###
+### Step 6: Help us by reviewing other Pull Requests! ###
 If you have the time and the knowledge then you must review other Pull Requests. This would stop Pull Requests from stacking up and will definitely mean your Pull Request would be reviewed faster.
 
 **Things to keep in mind while reviewing a Pull Request:**
@@ -102,5 +114,3 @@ If any of the following questions has a **YES** for an answer then the request s
 * Are there unnecessary changes?
 * Is a rebase required?
 * Is the fix dirty / hacky?
-
-*Note: Reviewers shall make sure that the reviews are done on a first come, first served basis.*