aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2020-01-19 13:04:43 -0600
committerEugene Triguba <eugenetriguba@gmail.com>2020-01-19 13:04:43 -0600
commit869f6ffd0614337d688e5aafa3ebc2220dacb1c1 (patch)
tree1efed3f8c3b4a8fa6f32ac88e76a48dc2882c6d1
parentOnly use matrix and change to include lint + test stages (diff)
downloadconfig-file-869f6ffd0614337d688e5aafa3ebc2220dacb1c1.zip
Add CI pipeline details to contributing guidelines
-rw-r--r--CONTRIBUTING.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 9a0dcc0..e5c2b0c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -49,9 +49,12 @@ Here are some guidelines to keep in mind when submitting a pull request:
```bash
pre-commit install
```
-
- If the pipeline is acting oddly, you can skip it with the ``--no-verify`` option
- to ``git push``.
+
+- CI Pipeline: There is a CI pipeline that is run by Travis CI on commits to master and
+ on pull requests.
+
+ - All it does is ensure that all the tests pass and that all the files adhere to the
+ standard format (`pre-commit run --all-files`).
To get started, make sure you have poetry installed and run ``poetry install`` and
``poetry shell`` to enter the virtual environment. \ No newline at end of file