Update CONTRIBUTING.md

CONTRIBUTING.md

@@ -9,7 +9,7 @@ You can contribute in many ways:
 
 ### Report Bugs
 
-Report bugs at <https://github.com/zostera/django-bootstrap5/issues>.
+Report bugs at <https://github.com/zostera/django-bootstrap4/issues>.
 
 If you are reporting a bug, please include:
 
@@ -27,12 +27,12 @@ Look through the GitHub issues for features. Anything tagged with \"feature\" is
 
 ### Write Documentation
 
-`django-bootstrap5` could always use more documentation, whether as part of the official django-bootstrap5 docs, in docstrings, or even on the web in blog posts, articles, and such.
+`django-bootstrap4` could always use more documentation, whether as part of the official django-bootstrap4 docs, in docstrings, or even on the web in blog posts, articles, and such.
 
 ### Submit Feedback
 
 The best way to send feedback is to file an issue at
-<https://github.com/zostera/django-bootstrap5/issues>.
+<https://github.com/zostera/django-bootstrap4/issues>.
 
 If you are proposing a feature:
 
@@ -41,42 +41,48 @@ If you are proposing a feature:
 
 ## Get Started!
 
-Ready to contribute? Here\'s how to set up `django-bootstrap5` for local development.
+Ready to contribute? Here\'s how to set up `django-bootstrap4` for local development.
 
 You will need some knowledge of git, github, and Python/Django development. Using a Python virtual environment is advised.
 
-1. Fork and clone `django-bootstrap5` repo on GitHub. There is an excellent guide at <https://guides.github.com/activities/forking/>.
-2. Install [poetry](https://python-poetry.org).
-3. Inside your local `django-bootstrap5` folder, run
- ```shell script
- $ poetry install
- ```
-4. Create a branch for local development:
- ```shell script
- $ git checkout -b name-of-your-bugfix-or-feature
- ```
- Now you can make your changes locally.
-5. When you\'re done making changes, check that your changes pass the tests.
- Run the unit tests in your virtual environment with the `manage.py` command:
- ```shell script
- $ python manage.py test
- ````
- Run the extended tests with `tox`:
- ```shell script
- $ make tox
- ```
-6. Commit your changes and push your branch to GitHub:
- ```shell script
- $ git add .
- $ git commit -m "Your detailed description of your changes."
- $ git push origin name-of-your-bugfix-or-feature
- ```
-7. Submit a pull request through the GitHub website.
+### Local installation
+
+This section assumes you know about local Python versions and virtual environments.
+
+To clone the repository and install the requirements for local development:
+
+```shell-script
+git clone git:https://github.com/zostera/django-bootstrap4.git
+cd django-bootstrap4
+pip install -e .
+pip install -U pip -r requirements-dev.txt
+```
+
+### Running the example app
+
+You can run the example app:
+
+```shell-script
+cd example && python manage.py runserver
+```
+
+### Running the tests
+
+The test suite requires tox to be installed. Run the complete test suite like this:
+
+```shell-script
+make tox
+```
+
+Test for the current environment can be run with the Django manage.py command.
+
+```shell-script
+python manage.py test
+```
 
 ## Pull Request Guidelines
 
 Before you submit a pull request, check that it meets these guidelines:
 
-1. The pull request should include tests.
+1. The pull request should include tests for new or changed functionality, and pass all 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 CHANGELOG.md.
-3. The pull request should pass the Continuous Integration tests. Check <https://travis-ci.org/zostera/django-bootstrap5/pull_requests> and make sure that all tests pass. You can run the tests locally using `tox`.