Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 1.15 KB

File metadata and controls

42 lines (30 loc) · 1.15 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

  • $EDITOR CHANGELOG.md: update CHANGELOG with new notes, version, and date.
  • commit changes
  • $EDITOR lib/pyld/__about__.py: update to release version and remove -dev suffix.
  • git commit CHANGELOG.md lib/pyld/__about__.py -m "Release {version}."
  • git tag {version}
  • $EDITOR lib/pyld/__about__.py: update to next version and add -dev suffix.
  • git commit lib/pyld/__about__.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