OpenSourceHelpCommunity · tapaswenipathak · Oct 21, 2017 · Oct 21, 2017 · Oct 21, 2017 · Oct 21, 2017
diff --git a/.DS_Store b/.DS_Store
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,7 @@
+[report]
+omit =
+    *migrations*
+    */tests/*
+    oshc/manage.py
+    oshc/oshc/*
+    */admin.py
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,6 @@
+[flake8]
+ignore =
+    # A continuation line is under-indented for a visual indentation.
+    E128
+
+max-line-length=80
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,13 @@
+exclude: '^$'
+fail_fast: true
+repos:
+-   repo: https://github.com/pre-commit/mirrors-yapf
+    sha: v0.20.0
+    hooks:
+    -   id: yapf
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    sha: v1.1.1
+    hooks:
+    -   id: check-yaml
+    -   id: check-added-large-files
+    -   id: flake8
diff --git a/.travis.yml b/.travis.yml
@@ -16,14 +16,15 @@ install:
   - pip install coveralls
 
 before_script:
+  -  export SECRET_KEY='x1-pogt0-b5owbgq0=ui02-4v)bba!bg&1m8_$)8-&13(907qf'
   - psql -c 'create database travis_ci_test;' -U postgres
   - cd oshc/
   - python manage.py migrate --noinput
   - python manage.py collectstatic --noinput
+  - git diff-tree --no-commit-id --name-only -r $REVISION | xargs pre-commit run --files
 
 script:
-  - flake8 . --ignore=E128
-  - coverage run --source='main' manage.py test --verbosity 2
+  - coverage run --source='.'  manage.py test --verbosity 2
 
 after_success:
   - coverage report

diff --git a/README.md b/README.md
@@ -9,53 +9,66 @@ We are trying to create a medium where people who want to start with contributin
 [Website](http://opensourcehelpcommunity.herokuapp.com/) [WIP]
 
 ## Deployement details
+
 After every commit
 
 1. The `predev` branch on GitHub is automatically deployed to [opensourcehelpcommunity-predev.herokuapp.com](http://opensourcehelpcommunity-predev.herokuapp.com/).
-2. The `develop` branch on github is automatically deployed to [opensourcehelpcommunity-dev.herokuapp.com](http://opensourcehelpcommunity-dev.herokuapp.com/).
-3. The `master` branch is automatically deployed [to opensourcehelpcommunity.herokuapp.com](http://opensourcehelpcommunity.herokuapp.com/) .
+1. The `develop` branch on github is automatically deployed to [opensourcehelpcommunity-dev.herokuapp.com](http://opensourcehelpcommunity-dev.herokuapp.com/).
+1. The `master` branch is automatically deployed [to opensourcehelpcommunity.herokuapp.com](http://opensourcehelpcommunity.herokuapp.com/) .
 
 This is using [Django(1.11)](https://www.djangoproject.com/) and [Bootstrap](http://getbootstrap.com/)
 
 ## How to Contribute
-This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. This project adheres to the Collaborative [code of conduct](https://github.com/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io/blob/develop/CODE_OF_CONDUCT.md). By participating, you expect to maintain the code of conduct. Before creating `New issue` and `Pull request`, please refer to the [template](docs).  
+
+This is an Open Source project and we would be happy to see contributors who report bugs and file feature requests submitting pull requests as well. This project adheres to the Collaborative [code of conduct](https://github.com/OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io/blob/develop/CODE_OF_CONDUCT.md). By participating, you expect to maintain the code of conduct. Before creating `New issue` and `Pull request`, please refer to the [template](docs).
 
 All the development is done on `predev` branch and once we're ready for testing the deployment in real environment with databases we merge the `predev` branch with the `develop` branch. When we're ready for new release we merge `develop` with `master` to deploy it on our main website. **Please submit your pull request based on `predev` branch.**
 
 ## Installations
+
 Run
-```
+
+```bash
 pip install -r requirements.txt
 ```
-to install everything required to run this project on heroku as well as on your local.
 
+to install everything required to run this project on heroku as well as on your local.
 
 ## To run this in your local
 
 1. Clone this repository using
-	```
-	git clone git@github.com:OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io.git
-	```
 
-2. Go inside main Django app [Instructional video on installing Django](https://youtu.be/qgGIqRFvFFk)
-	```
-	cd oshc
-	```
+   ```bash
+   git clone git@github.com:OpenSourceHelpCommunity/OpenSourceHelpCommunity.github.io.git
+   ```
+
+1. Go inside main Django app [Instructional video on installing Django](https://youtu.be/qgGIqRFvFFk)
+
+   ```bash
+   cd oshc
+   ```
+
+1. Install [pre-commit](http://pre-commit.com/) into your git hooks. [pre-commit](http://pre-commit.com/) will now run on every commit. Every time you clone a project that is using [pre-commit](http://pre-commit.com/) running [pre-commit](http://pre-commit.com/) install should always be the first thing you do after installing requirements.
+
+   ```bash
+   pre-commit install
+   ```
+
+1. Collectstatic files using
 
-3. Collectstatic files using
-	```
-	python manage.py collectstatic
-	```
+   ```bash
+   python manage.py collectstatic
+   ```
 
-4. Run the app
-	```
-	python manage.py runserver
-	```
+1. Run the app
+   ```bash
+   python manage.py runserver
+   ```
 
 To run the web app in Debug mode set the DEBUG environment variable.
 In Linux, run the `export DEBUG=True` command in the terminal.
 
 Feel free to raise and fix issues.
 For any questions, join #oshc-dev on Slack. Get an invite [here](https://opensourcehelp.herokuapp.com/).
 
-Note : All design related tasks have reward associated with them.
+Note: All design related tasks have reward associated with them.
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = OpenBuds
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/PULL_REQUEST_TEMPLATE.md b/docs/PULL_REQUEST_TEMPLATE.md
@@ -3,7 +3,7 @@
 
 **Checklist**
 
-- [ ] My branch is up-to-date with the upstream `develop` branch.
+- [ ] My branch is up-to-date with the upstream `predev` branch.
 - [ ] I have added necessary documentation (if appropriate).
 
 **Which issue does this PR fix?**: fixes #

diff --git a/docs/make.bat b/docs/make.bat
@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=OpenBuds
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd