Merge pull request #11 from maticardenas/fix-readme

README.md update and adding CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+This package is open to contributions 👏
+
+To contribute, please follow these steps:
+
+1. Fork the upstream repository into a personal account.
+2. Install [poetry](https://python-poetry.org/), and install all dependencies using ``poetry install``
+3. Install [pre-commit](https://pre-commit.com/) (for project linting) by running ``pre-commit install``
+4. Create a new branch for your changes, and make sure to add tests!
+5. Push the topic branch to your personal fork
+6. Run `pre-commit run --all-files` locally to ensure proper linting
+7. Create a pull request to the snok repository with a detailed summary of your changes and what motivated the change

README.md

@@ -1,16 +1,18 @@
-[![PyPI](https://img.shields.io/pypi/v/drf-openapi-tester.svg)](https://pypi.org/project/drf-openapi-tester/)
-[![Coverage](https://codecov.io/gh/snok/drf-openapi-tester/branch/master/graph/badge.svg)](https://codecov.io/gh/snok/drf-openapi-tester)
-[![Python versions](https://img.shields.io/badge/Python-3.7%2B-blue)](https://pypi.org/project/drf-openapi-tester/)
-[![Django versions](https://img.shields.io/badge/Django-3.0%2B-blue)](https://pypi.org/project/drf-openapi-tester/)
+[![PyPI](https://img.shields.io/pypi/v/drf-openapi-tester.svg)](https://pypi.org/project/drf-contract-tester/)
+[![Coverage](https://codecov.io/gh/snok/drf-openapi-tester/branch/master/graph/badge.svg)](https://codecov.io/gh/maticardenas/drf-contract-tester)
+[![Python versions](https://img.shields.io/badge/Python-3.7%2B-blue)](https://pypi.org/project/drf-contract-tester/)
+[![Django versions](https://img.shields.io/badge/Django-3.0%2B-blue)](https://pypi.org/project/drf-contract-tester/)
 
 
 # DRF Contract Tester
 
-This is a test utility to validate DRF Test Responses against OpenAPI 2 and 3 schema. It has built-in support for:
+This is a test utility to validate DRF Test requests & responses against OpenAPI 2 and 3 schema. It has built-in support for:
 
 - OpenAPI 2/3 yaml or json schema files.
-- OpenAPI 2 schemas created with [drf-yasg](https://github.com/axnsan12/drf-yasg).
-- OpenAPI 3 schemas created with [drf-spectacular](https://github.com/tfranzel/drf-spectacular).
+- OpenAPI 2 schemas created with [drf-yasg](https://github.com/axnsan12/drf-yasg).*
+- OpenAPI 3 schemas created with [drf-spectacular](https://github.com/tfranzel/drf-spectacular).*
+
+*For `drf-yasg` and `drf-spectacular` support is for now only for responses.
 
 ## Installation
 
@@ -259,4 +261,4 @@ the OpenAPI schema.
 
 ## Contributing
 
-Contributions are welcome. Please see the [contributing guide](https://github.com/snok/.github/blob/main/CONTRIBUTING.md)
+Contributions are welcome. Please see the [contributing guide](https://github.com/maticardenas/drf-contract-tester/blob/master/CONTRIBUTING.md)

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "drf-contract-tester"
-version = "3.3.5"
+version = "3.3.6"
 description = "Test utility for validating OpenAPI response documentation"
 authors =["Matías Cárdenas <[email protected]>", "Sondre Lillebø Gundersen <[email protected]>", "Na'aman Hirschfeld <[email protected]>"]
 license = "BSD-4-Clause"