chore: fix repo links

This commit is contained in:
Mike 2021-10-21 19:55:47 +00:00 committed by GitHub
parent 5ca7791b57
commit edd050dd98
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 31 additions and 8 deletions

View file

@ -11,7 +11,30 @@ We love your input! We want to make contributing to this project as easy and tra
- Proposing new features - Proposing new features
- Becoming a maintainer - 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 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 ### 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. 3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes. 4. Ensure the test suite passes.
5. Make sure your code lints. 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 ### 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. 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) ### 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/makimo/django-eav2/blob/master/.github/ISSUE_TEMPLATE/bug_report.md) template to describe your reports. 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 ### 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.
<hr> <hr>

View file

@ -1,4 +1,4 @@
{% extends "!layout.html" %} {% extends "!layout.html" %}
{% block extrahead %} {% block extrahead %}
<a href="https://github.com/lvm/django-eav2"><img style="position: fixed; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a> <a href="https://github.com/jazzband/django-eav2"><img style="position: fixed; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png" alt="Fork me on GitHub"></a>
{% endblock %} {% endblock %}

View file

@ -6,6 +6,6 @@ Django EAV 2 is an entity-attribute-value storage for modern Django.
<ul> <ul>
<li><a href="index.html">Home</a></li> <li><a href="index.html">Home</a></li>
<li><a href="https://pypi.org/project/django-eav2/">PyPI</a></li> <li><a href="https://pypi.org/project/django-eav2/">PyPI</a></li>
<li><a href="http://github.com/lvm/django-eav2">GitHub</a></li> <li><a href="https://github.com/jazzband/django-eav2">GitHub</a></li>
<li><a href="http://github.com/lvm/django-eav2/issues">Issue Tracker</a></li> <li><a href="https://github.com/jazzband/django-eav2/issues">Issue Tracker</a></li>
</ul> </ul>