From edd050dd985ea467163ecbebf17141cceae7b76a Mon Sep 17 00:00:00 2001 From: Mike Date: Thu, 21 Oct 2021 19:55:47 +0000 Subject: [PATCH] chore: fix repo links --- CONTRIBUTING.md | 33 ++++++++++++++++++++---- docs/source/_templates/layout.html | 2 +- docs/source/_templates/sidebarintro.html | 4 +-- 3 files changed, 31 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 438a0dc..c5bb2d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,30 @@ We love your input! We want to make contributing to this project as easy and tra - Proposing new features - Becoming a maintainer -### We develop with Github +## Dependencies + +We use [poetry](https://github.com/sdispater/poetry) to manage the dependencies. + +To install them you would need to run `install` command: + +```bash +poetry install +``` + +To activate your `virtualenv` run `poetry shell`. + + +## Tests + +We use `pytest` and `flake8` for quality control. + +To run all tests: + +```bash +pytest +``` + +## We develop with Github We use github to host code, to track issues and feature requests, as well as accept pull requests. ### We use [Github Flow](https://guides.github.com/introduction/flow/index.html), so all code changes from community happen through pull requests @@ -22,18 +45,18 @@ Pull requests are the best way to propose changes to the codebase (we use [Githu 3. If you've changed APIs, update the documentation. 4. Ensure the test suite passes. 5. Make sure your code lints. -6. Describe the pull request using [this](https://github.com/makimo/django-eav2/blob/master/PULL_REQUEST_TEMPLATE.md) template. +6. Describe the pull request using [this](https://github.com/jazzband/django-eav2/blob/master/PULL_REQUEST_TEMPLATE.md) template. ### Any contributions you make will be under the GNU Lesser General Public License v3.0 In short, when you submit code changes, your submissions are understood to be under the same [LGPLv3](https://choosealicense.com/licenses/lgpl-3.0/) that covers the project. Feel free to contact the maintainers if that's a concern. -### Report bugs using Github's [issues](https://github.com/makimo/django-eav2/issues) -We use GitHub issues to track public bugs. Report a bug by opening a new issue. Use [this](https://github.com/makimo/django-eav2/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) template to describe your reports. +### Report bugs using Github's [issues](https://github.com/jazzband/django-eav2/issues) +We use GitHub issues to track public bugs. Report a bug by opening a new issue. Use [this](https://github.com/jazzband/django-eav2/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) template to describe your reports. ### Use a consistent coding style -We use [PEP-8](https://www.python.org/dev/peps/pep-0008/) (whenever it makes sense) for code and [Google-style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) reStructuredText for doc-strings. +We use [Black](https://github.com/psf/black) and (working towards) [wemake-python-styleguide](https://github.com/wemake-services/wemake-python-styleguide) for code and [Google-style](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) reStructuredText for doc-strings.
diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html index 53c102c..0a13596 100644 --- a/docs/source/_templates/layout.html +++ b/docs/source/_templates/layout.html @@ -1,4 +1,4 @@ {% extends "!layout.html" %} {% block extrahead %} -Fork me on GitHub +Fork me on GitHub {% endblock %} diff --git a/docs/source/_templates/sidebarintro.html b/docs/source/_templates/sidebarintro.html index 6ecc2ae..9fa0d68 100644 --- a/docs/source/_templates/sidebarintro.html +++ b/docs/source/_templates/sidebarintro.html @@ -6,6 +6,6 @@ Django EAV 2 is an entity-attribute-value storage for modern Django.