Skip to content

Commit c273538

Browse files
committed
tidy up docs a bit
1 parent 177bb52 commit c273538

File tree

3 files changed

+14
-5
lines changed

3 files changed

+14
-5
lines changed

docs/contributing.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
## Licencing
12
Unless you explicitly state otherwise, any contribution intentionally submitted
23
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
34
dual licensed as above, without any additional terms or conditions.
5+
6+

docs/development.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
1-
## Running tests
1+
## Testing strategy
2+
3+
Test coverage is and should remain near 100%.
24

3-
Test coverage is and should remain 100%. The library is very small and a minio
4-
server can be very easily brought up with docker, so there is no reason to use
5-
mocking most of the time, the tests should run directly against a real minio
6-
instance.
5+
This package is very small and a minio server can be very easily brought up
6+
with docker so there is typically no reason to use mocking at all. The tests
7+
should run directly against a real minio server instance.
8+
9+
## Running tests
710

811
To run the tests you need to have minio running locally with some specific
912
settings, you can start it using docker-compose:

docs/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ adapters for S3 should work, but in practice they are hard to configure. This
88
project uses the minio python client instead. Inspiration has been drawn from
99
`django-s3-storage` and `django-storages`.
1010

11+
The project source code and issue tracking is hosted at
12+
[github.com/py-pa/django-minio-storage](https://github.com/py-pa/django-minio-storage).
13+
1114
# Compatibility
1215

1316
CI is currenlty executed on Python 3.8+ and Django 3.2+.

0 commit comments

Comments
 (0)