[skip ci] 📝 Improve Documentation

CONTRIBUTING.rst

@@ -1,11 +1,10 @@
 .. highlight:: shell
 
-============
+=============
 Contributing
-============
+=============
 
-Contributions are welcome, and they are greatly appreciated! Every little bit
-helps, and credit will always be given.
+Contributions are welcome and greatly appreciated! Every little bit helps, and credit will always be given.
 
 You can contribute in many ways:
 
@@ -26,21 +25,17 @@ If you are reporting a bug, please include:
 Fix Bugs
 ~~~~~~~~
 
-Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
-wanted" is open to whoever wants to implement it.
+Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
 
 Implement Features
 ~~~~~~~~~~~~~~~~~~
 
-Look through the GitHub issues for features. Anything tagged with "enhancement"
-and "help wanted" is open to whoever wants to implement it.
+Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
 
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-TIA Toolbox could always use more documentation, whether as part of the
-official TIA Toolbox docs, in docstrings, or even on the web in blog posts,
-articles, and such.
+TIA Toolbox could always use more documentation, whether as part of the official TIA Toolbox docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
@@ -50,9 +45,8 @@ The best way to send feedback is to file an issue at https://github.com/TissueIm
 If you are proposing a feature:
 
 * Explain in detail how it would work.
-* Keep the scope as narrow as possible, to make it easier to implement.
-* Remember that this is a volunteer-driven project, and that contributions
-  are welcome :)
+* Keep the scope as narrow as possible to make it easier to implement.
+* Remember that this is a volunteer-driven project, and contributions are welcome :)
 
 Get Started!
 ------------
@@ -64,7 +58,7 @@ Ready to contribute? Here's how to set up ``tiatoolbox`` for local development.
 
     $ git clone [email protected]:your_name_here/tiatoolbox.git
 
-3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
+3. Install your local copy into a virtual environment. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
     $ mkvirtualenv tiatoolbox
     $ cd tiatoolbox/
@@ -76,13 +70,18 @@ Ready to contribute? Here's how to set up ``tiatoolbox`` for local development.
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the
-   tests::
+5. When you're done making changes, check that your changes pass pre-commit and the tests::
 
-    $ flake8 tiatoolbox tests
+    $ pre-commit run --all-files
     $ python setup.py test or pytest
 
-   To get flake8, just pip install them into your virtualenv.
+   To get `pre-commit <https://pre-commit.com/#install>`_, just pip install it into your virtual environment using::
+
+    $ pip install pre-commit
+
+   To set up the git hook for pre-commit, run the following command after installing pre-commit::
+
+    $ pre-commit install
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -98,20 +97,15 @@ Pull Request Guidelines
 Before you submit a pull request, check that it meets these guidelines:
 
 1. The pull request should include tests.
-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.8, 3.9 and 3.10, and for PyPy. Check
-   https://travis-ci.com/tialab/tiatoolbox/pull_requests
-   and make sure that the tests pass for all supported Python versions.
+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.9, 3.10, 3.11, and 3.12, and for PyPy. Check https://github.com/TissueImageAnalytics/tiatoolbox/actions/workflows/python-package.yml and make sure that the tests pass for all supported Python versions.
 
 Tips
 ----
 
 To run a subset of tests::
 
-$ pytest tests.test_tiatoolbox
-
+    $ pytest tests.test_tiatoolbox
 
 Deploying
 ---------
@@ -120,8 +114,8 @@ A reminder for the maintainers on how to deploy.
 Make sure all your changes are committed (including an entry in HISTORY.rst).
 Then run::
 
-$ poetry version patch # use: "poetry version --help" for other options
-$ git push
-$ git push --tags
+    $ poetry version patch  # use: "poetry version --help" for other options
+    $ git push
+    $ git push --tags
 
-Travis will then deploy to PyPI if tests pass.
+GitHub Actions will then deploy to PyPI if tests pass.