Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 4.13 KB

CONTRIBUTING.md

File metadata and controls

94 lines (68 loc) · 4.13 KB
Raw

Contributing to rsconnect-python

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

To get started, you'll want to:

  • clone the repo into a project directory
  • setup a virtual 3.8+ python environment in the project directory
  • activate that virtual environment
  • install the dependencies
  • validate your build environment with some sample commands

While there are several different tools and techniques you can use to accomplish the steps listed above, the following is an example which uses venv.

# Clone the repo
cd ~/dev
git clone https://github.com/posit-dev/rsconnect-python.git
cd rsconnect-python
# Setup a virtual python environment
python3 -m venv .venv
# Activate the virtual environment
source .venv/bin/activate
# Install rsconnect-python with a symbolic link to the locations repository,
# meaning any changes to code in there will automatically be reflected.
# Also install dev/test dependencies.
pip install -e '.[test]'

Workflow

With your venv setup and active, as described previously, running rsconnect-python using your codebase is as simple as running the rsconnect command from the terminal.

Typical makefile targets are:

# verify code formats are correct
make fmt
# lint the codebase
make lint
# run the tests (w/ python 3.8)
make test
# run the tests with all versions of python
make all-tests

As another example, the test job in the default GitHub Actions workflow uses some of these targets during the CI 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.

Before releasing, replace the Unreleased heading in the CHANGELOG.md with the version number and date. Update CHANGELOG.md before EACH release, even beta releases, in order to avoid one commit with multiple tags (pypa/setuptools-scm#521).

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.

Updating rsconnect-python on conda-forge

rsconnect-python exists on conda-forge as its own feedstock

Updating the package requires a fork of the repository and a push request.

  • For new version/release, update the meta.yaml file with the new version number, source url, and corresponding checksum.

  • For a rebuild of the same version, increase "number" under "build" by one in the meta.yaml file.

Once the proposed change is pushed, follow the checklist.

Adding yourself as a rsconnect-python conda-forge maintainer

Add your github username under recipe-maintainers in the meta.yaml file.