Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 2.21 KB

CONTRIBUTING.md

File metadata and controls

59 lines (44 loc) · 2.21 KB
Raw

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behaviour to the Sceptre github discussion.

How to Contribute

Dependency Management

Poetry is the tool that is used for dependency management, versioning and deployment management to pypi. Please install poetry and execute commands from the poetry environment.

Linting

As a pre-deployment step we syntatically validate files with pre-commit.

Please install pre-commit then run pre-commit install to setup the git hooks. Once configured the pre-commit linters will automatically run on every git commit. Alternatively you can manually execute the validations by running pre-commit run --all-files.

Unit Tests

Tox is used to execute tests against multiple python versions inside of poetry virtual environments.

$ poetry run tox

Releasing

Poetry is used to manage versions and deployments. Follow the below steps to release a version to pypi.

  • Update the CHANGELOG.md with changes (see the example in the CHANGELOG comments).
  • Bump the package version (i.e. poetry version minor)
  • Create a release PR and have it reviewed, approved and then merged
  • Create a git tag (i.e git tag -as x.y.z)
  • Push the tag which will trigger a CI job to deploy to PyPi.

Get Started

  1. Fork this repository
  2. Clone your fork locally
  3. Create a branch for local development
  4. Install dependencies (i.e. poetry install)
  5. Update the pyproject.toml file with information specific to the project. Refer to the poetry documentation for a reference to the configurations.
  6. Add source code and tests for the project.
  7. When you're done making changes, check that your changes pass linting, unit tests and have sufficient coverage.
  8. Submit a pull request through the GitHub website.