Permalink
Fetching contributors…
Cannot retrieve contributors at this time
42 lines (29 sloc) 1.05 KB

Contributing to PyLD

Want to contribute to PyLD? Great! Here are a few notes:

Code

  • In general, follow the common PEP 8 Style Guide.
  • Try to make the code pass flake8 checks.
    • flake8 lib/pyld/jsonld.py
  • Use version X.Y.Z-dev in dev mode.
  • Use version X.Y.Z for releases.

Versioning

Release Process

  • commit changes
  • $EDITOR lib/pyld/jsonld.py: update to release version and remove -dev suffix.
  • git commit lib/pyld/jsonld.py -m "Release {version}."
  • git tag {version}
  • $EDITOR lib/pyld/jsonld.py: update to next version and add -dev suffix.
  • git commit lib/pyld/jsonld.py -m "Start {next-version}."
  • git push --tags

To ensure a clean upload, use a clean checkout, and run the following:

  • git checkout {version}
  • python setup.py sdist upload