Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.5 KB

CONTRIBUTING.md

File metadata and controls

35 lines (24 loc) · 1.5 KB

Contributing to rsconnect-python

This project aims to uphold Python community norms and make use of recommended tooling.

Workflow

The test job in the default GitHub Actions workflow reflects a typical set of steps for building and testing.

Proposing Change

Any and all proposed changes are expected to be made via pull request.

Versioning and Releasing

All version and release management is done via annotated git tags, as this is the repo metadata used by the setuptools_scm package to generate the version string provided as rsconnect:VERSION and output by rsconnect version.

To create a new release, create and push an annotated git tag:

git tag -a 1.2.3 -m 'Release 1.2.3'
git push origin 1.2.3

Once the tag push is received by GitHub, the relevant workflow action will be triggered and, upon successful completion, a release will be created and published to the repository releases and the public PYPI.

NOTE: Pre-releases versions must comply with PIP 440 in order for PIPY to appropriately mark them as pre-releases.