Skip to content

Commit

Permalink
Various minor fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
ngnpope committed Jul 2, 2022
1 parent b40aa8d commit 2367be1
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,27 +80,27 @@ Ready to contribute? Here's how to set up `tg-react` for local development.
poetry install
```

4. Create a branch for local development::
5. Create a branch for local development::
```shell
git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.

5. When you're done making changes, check that your changes pass linters and the tests, including testing other Python versions with tox:
6. When you're done making changes, check that your changes pass linters and the tests, including testing other Python versions with tox:
```shell
poetry run lint
poetry run test
poetry run test-all
poetry run make lint
poetry run make test
poetry run make test-all
```
6. Commit your changes and push your branch to GitHub::
7. Commit your changes and push your branch to GitHub::
```shell
git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
```
7. Submit a pull request through the GitHub website.
8. Submit a pull request through the GitHub website.
## Pull Request Guidelines
Expand All @@ -109,7 +109,7 @@ Before you submit a pull request, check that it meets these guidelines:
1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put
your new functionality into a function with a docstring, and add the
feature to the list in README.rst. You should also update the documentation
feature to the list in README.md. You should also update the documentation
source files via::
```shell
poetry run make docs
Expand All @@ -136,7 +136,7 @@ poetry run make test-all
To run a subset of tests:

```shell
poetry run py.test tests.test_tg_react
poetry run pytest tests.test_tg_react
```

Update documentation source files and generate it:
Expand Down
8 changes: 3 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: help clean clean-build clean-pyc lint test test-all test-full coverage docs release sdist update-messages add-locale
.PHONY: help clean clean-build clean-pyc lint black test test-all test-full coverage docs update-messages add-locale

help:
@echo "clean-build - remove build artifacts"
Expand All @@ -9,8 +9,6 @@ help:
@echo "test-full - shorthand for test lint coverage"
@echo "coverage - check code coverage quickly with the default Python"
@echo "docs - generate Sphinx HTML documentation, including API docs"
@echo "release - package and upload a release"
@echo "sdist - package"
@echo "update-messages - Update translation files"
@echo "add-locale - Add a new translation locale"

Expand All @@ -33,15 +31,15 @@ black:
black demo dummy_settings.py tg_react

test:
py.test
pytest

test-all:
tox

test-full: test lint coverage

coverage:
py.test --cov-config .coveragerc --cov=tg_react --cov-report html --cov-report term-missing
pytest --cov-config .coveragerc --cov=tg_react --cov-report html --cov-report term-missing

docs:
mkdir -p docs/_static
Expand Down

0 comments on commit 2367be1

Please sign in to comment.