tidy up docs a bit

py-pa · May 7, 2023 · c273538 · c273538
1 parent 177bb52
commit c273538
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,3 +1,6 @@
+## Licencing
 Unless you explicitly state otherwise, any contribution intentionally submitted
 for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
 dual licensed as above, without any additional terms or conditions.
+
+
diff --git a/docs/development.md b/docs/development.md
@@ -1,9 +1,12 @@
-## Running tests
+## Testing strategy
+
+Test coverage is and should remain near 100%.
 
-Test coverage is and should remain 100%. The library is very small and a minio
-server can be very easily brought up with docker, so there is no reason to use
-mocking most of the time, the tests should run directly against a real minio
-instance.
+This package is very small and a minio server can be very easily brought up
+with docker so there is typically no reason to use mocking at all. The tests
+should run directly against a real minio server instance.
+
+## Running tests
 
 To run the tests you need to have minio running locally with some specific
 settings, you can start it using docker-compose:

diff --git a/docs/index.md b/docs/index.md
@@ -8,6 +8,9 @@ adapters for S3 should work, but in practice they are hard to configure. This
 project uses the minio python client instead. Inspiration has been drawn from
 `django-s3-storage` and `django-storages`.
 
+The project source code and issue tracking is hosted at
+[github.com/py-pa/django-minio-storage](https://github.com/py-pa/django-minio-storage).
+
 # Compatibility
 
 CI is currenlty executed on Python 3.8+ and Django 3.2+.