From e4ffa681d4b0b1c3c4859ec9a5d7fdbcdad6e8ca Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 29 Mar 2021 18:11:00 +0000 Subject: [PATCH 1/2] Bump pygments from 2.5.2 to 2.7.4 in /docs Bumps [pygments](https://github.com/pygments/pygments) from 2.5.2 to 2.7.4. - [Release notes](https://github.com/pygments/pygments/releases) - [Changelog](https://github.com/pygments/pygments/blob/master/CHANGES) - [Commits](https://github.com/pygments/pygments/compare/2.5.2...2.7.4) Signed-off-by: dependabot[bot] --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index ae5868a0c..13a74df1b 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -40,7 +40,7 @@ mkdocs==1.1.2 # mkdocs-material nltk==3.5 # via lunr -pygments==2.5.2 +pygments==2.7.4 # via # -r requirements.human # mkdocs-material From 83672b5327f62e11783c41df7f3bd0a37863d997 Mon Sep 17 00:00:00 2001 From: Yves Bastide Date: Mon, 29 Mar 2021 21:02:11 +0200 Subject: [PATCH 2/2] Unrelated: fix CONTRIBUTING.md Fix small rst-to-md bugs and such. Signed-off-by: Yves Bastide --- CONTRIBUTING.md | 39 +++++++++++++++++++++++++++------------ 1 file changed, 27 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 24aded107..fa718feb4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,16 +22,20 @@ In Particular **Setting Up for Local Development** -1. Fork `simpleflow`_ on Github. -2. Clone your fork:: - +1. Fork `simpleflow` on Github. +2. Clone your fork: + ```shell $ git clone git@github.com/botify-labs/simpleflow.git + ``` -3. Make your virtualenv and install dependencies. If you have virtualenv and virtualenvwrapper_, run:: +3. Make your virtualenv and install dependencies. If you have virtualenv and virtualenvwrapper, run: + ```shell $ mkvirtualenv simpleflow $ cd simpleflow + $ pip install -e . $ pip install -r requirements-dev.txt + ``` - If you don't have virtualenv and virtualenvwrapper, you can install both using `virtualenv-burrito`. @@ -44,34 +48,45 @@ This branch is (hopefully) always stable. **Pull Requests** -1. Create a new local branch. :: +1. Create a new local branch. - $ git checkout -b name-of-feature + ```shell + $ git checkout -b name-of-feature + ``` 2. Commit your changes. Write [good commit messages](http://chris.beams.io/posts/git-commit/). + ```shell $ git commit -m "Detailed commit message" $ git push origin name-of-feature + ``` 3. Before submitting a pull request, check the following: - If the pull request adds functionality, it should be tested and the docs should be updated. - - The pull request should work on Python 2.7 and PyPy. Use `tox` to verify that it does. + - The pull request should work on Python 2.7, Python 3.8 and PyPy. Use `tox` to verify that it does. 4. Submit a pull request to the `main` branch. **Running tests** -To run all the tests in your current virtual environment: :: +To run all the tests in your current virtual environment: - $ ./script/test +```shell +$ ./script/test +``` This is what Travis CI does on each environment. If you want to simulate what Travis CI does, you can approach that by running a container from them: - $ ./script/test-travis python2.7 - $ ./script/test-travis pypy +```shell +$ ./script/test-travis python2.7 +$ ./script/test-travis python3.8 +$ ./script/test-travis pypy +``` -This can help you simulate locally what Travis CI would do. Be aware though that tests may fail depending on your OS, so Travis CI is the reference gate for the project. For instance, installing `subprocess32` in a Pypy environment doesn't work on Mac OSX. +This can help you simulate locally what Travis CI would do. Be aware though that tests may fail depending on your OS, +so Travis CI is the reference gate for the project. For instance, installing `subprocess32` in a PyPy environment +doesn't necessarily work on Mac OSX.