diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..988d72e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Guidance on how to contribute + +> By submitting a pull request or filing a bug, issue, or feature request, +> you are agreeing to comply with this waiver of copyright interest. +> Details can be found in our [LICENSE](LICENSE). + + +There are two primary ways to help: + - Using the issue tracker, and + - Changing the code-base. + + +## Using the issue tracker + +Use the issue tracker to suggest feature requests, report bugs, and ask questions. +This is also a great way to connect with the developers of the project as well +as others who are interested in this solution. + +Use the issue tracker to find ways to contribute. Find a bug or a feature, mention in +the issue that you will take on that effort, then follow the _Changing the code-base_ +guidance below. + + +## Changing the code-base + +Generally speaking, you should fork this repository, make changes in your +own fork, and then submit a pull request. All new code should have associated +unit tests that validate implemented features and the presence or lack of defects. +Additionally, the code should follow any stylistic and architectural guidelines +prescribed by the project. In the absence of such guidelines, mimic the styles +and patterns in the existing code-base. + diff --git a/README.rst b/README.rst index 7804402..7fd76dd 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,13 @@ Django Request Cache ==================== +.. image:: https://badge.fury.io/py/django-request-cache.svg + :target: https://badge.fury.io/py/django-request-cache +.. image:: https://github.com/anexia/django-request-cache/actions/workflows/test.yml/badge.svg?branch=main + :target: https://github.com/anexia/django-request-cache/actions/workflows/test.yml +.. image:: https://codecov.io/gh/anexia/django-request-cache/branch/main/graph/badge.svg + :target: https://codecov.io/gh/anexia/django-request-cache + Django Request Cache provides a cache for each request (within your Django Request/Response cycle). Quick start diff --git a/setup.py b/setup.py index 8a582b2..2c2da85 100644 --- a/setup.py +++ b/setup.py @@ -15,7 +15,7 @@ license='MIT', description='A simple Django app that provides a per-request cache.', long_description=README, - url='https://github.com/anexia-it/django-request-cache', + url='https://github.com/anexia/django-request-cache', author='Harald Nezbeda', author_email='hnezbeda@anexia-it.com', install_requires=[