minor improvements

romnn · Feb 14, 2021 · 0188871 · 0188871
1 parent 304f9c8
commit 0188871
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -88,7 +88,7 @@ After your project was created:
   it is likely that you are inside another shell that has been started sometime ago.
   Run ``exit`` and try again.
 
-  .. warning:: When you are done working on this project, run ``deactivate`` to deactivate the environment.
+  When you are done working on this project, run ``deactivate`` to deactivate the environment.
 
 * Make an initial release of your package to PyPI_. You will be asked for your credentials::
 

diff --git a/{{cookiecutter.project_slug}}/.github/workflows/test.yml b/{{cookiecutter.project_slug}}/.github/workflows/test.yml
@@ -3,7 +3,17 @@ name: test
 on: [push]
 
 jobs:
-  build:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+    - name: Code checks
+      uses: pre-commit/action@v2.0.0
+      with:
+        extra_args: --all-files
+
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:

diff --git a/{{cookiecutter.project_slug}}/README.rst b/{{cookiecutter.project_slug}}/README.rst
@@ -20,7 +20,7 @@
 
 """"""""
 
-Your short description here. `{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }} <https://{{ cookiecutter.github_username }}.github.io/{{ cookiecutter.project_slug }}>`_
+Your short description here. 
 
 .. code-block:: console
 
@@ -33,7 +33,7 @@ Your short description here. `{{ cookiecutter.github_username }}.github.io/{{ co
 Development
 -----------
 
-For detailed instructions see `CONTRIBUTING <CONTRIBUTING.rst>`_.
+For detailed instructions see the `contribution guide <CONTRIBUTING.rst>`_.
 
 Tests
 ~~~~~~~