Skip to content

Latest commit

 

History

History
60 lines (47 loc) · 2.26 KB

CONTRIBUTING.md

File metadata and controls

60 lines (47 loc) · 2.26 KB

Contribution Guidelines

Thank you for considering to help this project.

We welcome all support, whether on bug reports, code, design, reviews, tests, documentation, and more.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Development

Installation

Requirements: virtualenv, pyenv

git clone [email protected]:thibaudcolas/django-draftail.git
cd django-draftail/
# Install required Python versions
pyenv install --skip-existing 3.7.3
# Make required Python versions available globally.
pyenv global system 3.7.3
# Install the Python environment.
virtualenv .venv -p python3.7
source ./.venv/bin/activate
make init

Commands

make help            # See what commands are available.
make init            # Install dependencies and initialise for development.
make lint            # Lint the project.
make test            # Test the project.
make test-watch      # Restarts the tests whenever a file changes.
make test-coverage   # Run the tests while generating test coverage data.
make test-ci         # Continuous integration test suite.
make dev             # Restarts the example whenever a file changes.
make benchmark       # Runs a one-off performance (speed, memory) benchmark.
make clean-pyc       # Remove Python file artifacts.
make sdist           # Builds package version
make publish         # Publishes a new version to pypi.
make publish-test    # Publishes a new version to test pypi.

Debugging

  • Always run the tests. npm install -g nodemon, then make test-watch.
  • Use a debugger. pip install ipdb, then import ipdb; ipdb.set_trace().

Releases

  • Make a new branch for the release of the new version.
  • Update the CHANGELOG.
  • Update the version number in draftail/__init__.py, following semver.
  • Make a PR and squash merge it.
  • Back on master with the PR merged, use make publish-test (confirm, and enter your password, confirm everything good on test.pypi.org).
  • Back on master with the PR merged, use make publish (confirm, and enter your password).
  • Finally, go to GitHub and create a release and a tag for the new version.
  • Done!