Docs

CONTRIBUTING.md

@@ -163,16 +163,20 @@ like [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv),
 [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/), and
 [pyenv-virtualenvwrapper](https://github.com/pyenv/pyenv-virtualenvwrapper).
 
+for git related issues refer to https://github.com/101Loop/APIManager-Flutter/blob/master/CONTRIBUTING.md
+
 Next, get an up to date checkout of the `drf-user` repository:
 
+### For Linux Users:
+
 ```sh
-$ git clone [email protected]:101loop/drf-user.git
+$ git clone [email protected]:<your-username>/drf-user.git
 ```
 
 or if you want to use git via `https`:
 
 ```sh
-$ git clone https://github.com/101loop/drf-user.git
+$ git clone https://github.com/<your-github-username>/browser-history.git
 ```
 
 Change into the newly created directory and **after activating your virtual
@@ -226,6 +230,75 @@ Commit your changes and push your branch to GitHub:
 
 Submit a pull request through the GitHub website.
 
+### For setting up in windows system:
+
+You can either install "chocolatey" and run "choco install make" to use make functions
+or
+you can utilize the below commands
+
+```
+(env) $ cd drf-user
+(env) $ pip install -r requirements-dev.txt
+(env) $ pip install -e .
+```
+
+then do
+
+```
+pre-commit install
+```
+
+to test the app
+
+```
+(env) $ python -m pytest --disable-pytest-warnings --ds=tests.settings --cov=drf_user tests/
+(env) $ sphinx-autobuild --port 8888 -b html . _build/html  --open-browser
+
+```
+
+The built documentation can then be found in
+[`localhost:8888`](http://localhost:8888).
+
+Create a branch for local development:
+
+```
+(env) $ git checkout -b <branch_name>
+```
+
+Now you can make your changes locally.
+make sure the format is checked
+
+You can use
+```
+make check
+```
+
+or
+copy and run this block of commands
+```
+rm -rf build/
+rm -rf dist/
+rm -rf *.egg-info
+find . -name '*.pyc' -follow -print0 | xargs -0 rm -f
+find . -name '*.pyo' -follow -print0 | xargs -0 rm -f
+find . -name '__pycache__' -type d -follow -print0 | xargs -0 rm -rf
+rm -rf .coverage coverage*
+rm -rf tests/.coverage test/coverage*
+rm -rf htmlcov/
+flake8  --exclude=*/migrations/* --max-line-length 88 drf_user
+black --exclude .+/migrations/.+\.py drf_user
+(env) $ python -m pytest --disable-pytest-warnings --ds=tests.settings --cov=drf_user tests/
+```
+
+Commit your changes and push your branch to GitHub:
+
+```
+(env) $ git add .
+(env) $ git commit -m "Your detailed description of your changes."
+(env) $ git push origin name-of-your-bugfix-or-feature
+```
+
+
 ## Code of Conduct
 
 Please note that this project is released with a Contributor

docs/Makefile

@@ -24,7 +24,7 @@ html:
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html"
 
 livehtml:
-	sphinx-autobuild -p $(PORT) -b html $(SOURCEDIR) $(BUILDDIR)/html $(O)
+	sphinx-autobuild --port $(PORT) -b html $(SOURCEDIR) $(BUILDDIR)/html $(O) --open-browser
 
 linkcheck:
 	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck