Skip to content

Latest commit

 

History

History
37 lines (24 loc) · 1.11 KB

CONTRIBUTING.MD

File metadata and controls

37 lines (24 loc) · 1.11 KB

CONTRIBUTING

Development setup

  • Python >= 3.9. Refer Dockerfile to know which version is used officially.
  • Activate your virtual environment
  • Install make. Or you can read the Makefile to use the commands directly.
  • Install dev dependencies: make install-req-dev

Generate dependencies list

If you want to add dependencies into requirements.txt or dev-requirements.txt:

  • Install pip-tools: pip install pip-tools
  • Add your dependencies into pyproject.toml
  • Generate everything (and install them): make all-dep-actions

Bump version

To bump the version of the project to 1.0.1: tbump 1.0.1

Build & test Docker image

To build for local testing:

docker build --rm -t ghcr.io/itdevsamurai/atlassian-plugin-remote-install .

Run your test just like Quick Start but without --pull=always.

Contributing guide

  • Fork the project
  • Make changes
  • Test your changes via local Python & via Docker
  • Create PR to main