Closed daonb closed 7 years ago
Hi, thanks for the README improvements, these look good and good to merge if you're done.
- migrations - IMHO, post 1.0 we need to publish migrations
I can't remember what I meant in that paragraph, since migrations are already published as far as I can tell. Perhaps we should remove this section since it's more confusing than helpful.
- contributing guide - How do I install the dev environment, test and start coding?
In essence a contributor would need to do the following:
git clone
)run tox either directly or via setup.py helper (i.e tox
or python setup.py test
):
pyenv local
.To run for a specific version of python/django, you may pass the environment argument to select this specific combination. E.g:
$ tox -e py35-d110
When developing, it is suggested to run the smallest test case possible, and then expand from there to the full suite. For your convenience, the project is configured to run a travis-ci build (full matrix) on every commit and pull-request.
Feel free to commit the above section (or a clearer version) to this PR.
On a side note, we should probably make setup.py test
run the tests without any installation of environments or anything, as seen here: https://tox.readthedocs.io/en/latest/example/basic.html#integration-with-setup-py-test-command
I removed the confusing migrations paragraph, please merge. I open to send a separate PR with the contribution section.
Thanks for a great README.
Other then the minor edits I've made, there are two things we can improve:
regarding 1., If you'd like I can replace the paragraph about migrations with a paragraph about migrating from 0.x
Regarding 2, I'm stuck.
python setup.py test
crashes. Guess I'm doing something wrong. Here's the log: