Add CONTRIBUTING.md

kernc · Jan 5, 2019 · cc4ef27726a5643e66fa5ad670ebd6bc001275dd · cc4ef27
1 parent 22ad0eb
commit cc4ef27726a5643e66fa5ad670ebd6bc001275dd
Unified Split

Showing with 66 additions and 10 deletions.

+6 −0 .flake8

+1 −1 .travis.yml

+55 −0 CONTRIBUTING.md

+0 −8 README.md

+4 −1 setup.py
diff --git a/.flake8 b/.flake8
@@ -0,0 +1,6 @@
+  
+[flake8]
+  
+max-line-length = 100
+  
+exclude =
+  
+    .git,
+  
+    __pycache__,
+  
+    doc/examples
diff --git a/.travis.yml b/.travis.yml
@@ -20,7 +20,7 @@ matrix:
      before_script:
        - pip install flake8 coverage
      script:
-  
-        - flake8 --max-line-length=120 --exclude doc/examples .
+  
+        - flake8
        - BOKEH_BROWSER=none catchsegv coverage run setup.py test
      after_success:
        - bash <(curl -s https://codecov.io/bash)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,55 @@
+  
+Contributing guidelines
+  
+=======================
+  
+
+  
+Issues
+  
+------
+  
+Before reporting an issue, see if a similar issue is already open.
+  
+Also check if a similar issue was recently closed — your bug might
+  
+have been fixed already.
+  
+
+  
+To have your issue dealt with promptly, it's best to construct a
+  
+[minimal working example] that exposes the issue in a clear and
+  
+reproducible manner.
+  
+
+  
+[minimal working example]: https://en.wikipedia.org/wiki/Minimal_working_example
+  
+
+  
+
+  
+Installation
+  
+------------
+  
+To install a developmental version of the project,
+  
+first [fork the project]. Then:
+  
+
+  
+    git clone git@github.com:YOUR_USERNAME/backtesting.py
+  
+    cd backtesting.py
+  
+    pip3 install -e .[doc,test,dev]
+  
+
+  
+[fork the project]: https://help.github.com/articles/fork-a-repo/
+  
+
+  
+
+  
+Testing
+  
+-------
+  
+Please write reasonable unit tests for any new / changed functionality.
+  
+See _backtesting/test_ directory for existing tests.
+  
+Before submitting a PR, ensure the tests pass:
+  
+
+  
+    python setup.py test
+  
+
+  
+Also ensure that idiomatic code style is respected by running:
+  
+
+  
+    flake8  
+  
+
+  
+
+  
+Documentation
+  
+-------------
+  
+See _doc/README.md_. Besides Jupyter Notebook examples, all documentation
+  
+is generated from [pdoc]-compatible docstrings in code.
+  
+
+  
+[pdoc]: https://pdoc3.github.io/pdoc
+  
+
+  
+
+  
+Pull requests
+  
+-------------
+  
+Please use explicit commit messages. See [NumPy's development workflow]
+  
+for inspiration.
+  
+
+  
+[NumPy's development workflow]: https://docs.scipy.org/doc/numpy/dev/gitwash/development_workflow.html
diff --git a/README.md b/README.md
@@ -9,11 +9,3 @@ Backtest trading strategies with Python.
 [**Project website**](https://kernc.github.io/backtesting.py/)
 [Documentation](https://kernc.github.io/backtesting.py/doc/backtesting/)
-  
-
-  
-Development
-  
-----------
-  
-Fork the project. Then:
-  
-
-  
-    git clone git@github.com:YOUR_USERNAME/backtesting.py
-  
-    cd backtesting.py
-  
-    pip3 install -e .[doc]
diff --git a/setup.py b/setup.py
@@ -47,7 +47,10 @@ def _discover_tests():
            ],
            'test': [
                'seaborn',
-  
-            ]
+  
+            ],
+  
+            'dev': [
+  
+                'flake8',
+  
+            ],
        },
        test_suite="setup._discover_tests",
        python_requires='>=3.4',