chore(docs): updates repository links, flake8/test command and pr guidelines
@@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~
-Report bugs at https://github.com/silviatti/OCTIS/issues.
+Report bugs at https://github.com/MIND-Lab/OCTIS/issues.
If you are reporting a bug, please include:
@@ -45,7 +45,7 @@ articles, and such.
Submit Feedback
~~~~~~~~~~~~~~~
-The best way to send feedback is to file an issue at https://github.com/silviatti/OCTIS/issues.
+The best way to send feedback is to file an issue at https://github.com/MIND-Lab/OCTIS/issues.
If you are proposing a feature:
@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `OCTIS` for local development.
5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::
- $ flake8 OCTIS tests
+ $ flake8 octis tests
$ python setup.py test or pytest
$ tox
@@ -102,16 +102,17 @@ Before you submit a pull request, check that it meets these guidelines:
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
-3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
- https://travis-ci.com/silviatti/OCTIS/pull_requests
- and make sure that the tests pass for all supported Python versions.
+3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy.
+ Make sure you have `enabled workflow actions for your GitHub fork
+ <https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository>`_
+ and that the tests pass for all supported Python versions.
Tips
----
To run a subset of tests::
-$ pytest tests.test_OCTIS
+$ pytest tests/test_octis.py
Deploying
@@ -125,4 +126,4 @@ $ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags
-Travis will then deploy to PyPI if tests pass.
+GitHub Actions will then deploy to PyPI if tests pass.
