CONTRIBUTING.md

Contributing Guidelines

This documentation covers common tasks related to development.

For installation and usage instructions see README.md.

Table of Contents

• Contributing Guidelines
• Development
  • Trying out notebooks
  • Seeing code changes
• Packaging
• Versioning and Releases
  • Versioning
  • Releases
    • Releasing on Conda Forge
    • Adding yourself as a rsconnect-jupyter conda-forge maintainer

Development

Need to run this after checkout and when modifying the docker images

make images

Launch jupyter in a python 3 environment

make notebook3

Trying out notebooks

Note: notebooks in the notebooks3 directories will be available in respective python environments.

Sample notebooks can be obtained from:

• https://github.com/ipython/ipython-in-depth
• https://github.com/jupyter/jupyter/wiki/A-gallery-of-interesting-Jupyter-Notebooks
• https://losc.ligo.org/tutorials/
• http://nb.bianp.net/sort/views/

e.g.

cd notebooks3
git clone https://github.com/ipython/ipython-in-depth

Seeing code changes

When modifying JavaScript files simply refresh the browser window to see changes.

When modifying Python files restart the jupyter process to see changes.

Packaging

The following will create a universal wheel ready to be installed in any python 2 or python 3 environment.

make package

Versioning and Releases

Versioning

Versioning is accomplished via Git tagging using Semantic Versioning. Read more about tagging here. o view the most recent release tag, execute the following.

git describe master --match "v*" --tags

Releases

Releases are accomplished through GitHub Actions.

To initiate a release, create a manual tag use the following steps. The <MAJOR>.<MINOR>.<PATCH> values MUST follow semantic versioning.

git tag <MAJOR>.<MINOR>.<PATCH>
git push origin <MAJOR>.<MINOR>.<PATCH>

Once pushed, a GitHub Action will be trigged. This action with publish the release to PyPi using the specified version.

Releasing on Conda Forge

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

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

• 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.

Adding yourself as a rsconnect-jupyter conda-forge maintainer

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