Skip to content

Latest commit

 

History

History
223 lines (162 loc) · 7.62 KB

CONTRIBUTING.md

File metadata and controls

223 lines (162 loc) · 7.62 KB

Contributing to Sceptre

Thanks for your interest in Sceptre! We greatly appreciate any contributions to the project.

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

Report Bugs

Before submitting a bug, please check our issues page and discussion board to see if it's already been reported.

When reporting a bug, fill out the required template, and please include as much detail as possible as it helps us resolve issues faster.

Enhancement Proposal

Enhancement proposals should:

  • Use a descriptive title.
  • Provide a step-by-step description of the suggested enhancement.
  • Provide specific examples to demonstrate the steps.
  • Describe the current behaviour and explain which behaviour you expected to see instead.
  • Keep the scope as narrow as possible, to make it easier to implement.

Contributing Code

Contributions should be made in response to a particular GitHub Issue. We find it easier to review code if we've already discussed what it should do, and assessed if it fits with the wider codebase.

Beginner friendly issues are marked with the beginner friendly tag. We'll endeavour to write clear instructions on what we want to do, why we want to do it, and roughly how to do it. Feel free to ask us any questions that may arise.

A good pull request:

  • Is clear.
  • Works across all supported version of Python.
  • Complies with the existing codebase style (pre-commit)
  • Includes docstrings and comments for unintuitive sections of code.
  • Includes documentation for new features.
  • Includes tests cases that demonstrates the previous flaw that now passes with the included patch, or demonstrates the newly added feature.
  • New code should have 100% test coverage. The build will fail if overall code-coverage falls below 92%.
  • Is appropriately licensed (Apache 2.0).

Please keep in mind:

  • The benefit of contribution must be compared against the cost of maintaining the feature, as maintenance burden of new contributions are usually put on the maintainers of the project.

Get Started

  1. Fork the sceptre repository on GitHub.

  2. Clone your fork locally

$ git clone [email protected]:<github_username>/sceptre.git
  1. Install Sceptre for development (we recommend you use a virtual environment)
   $ cd sceptre/
   $ pip install -r requirements/prod.txt
   $ pip install -r requirements/dev.txt
   $ pip install -e .
  1. Create a branch for local development:
$ git checkout -b <branch-name>

  1. When you're done making changes, check that your changes pass linting, unit tests and have sufficient coverage and integration tests pass.

  2. Make sure the changes comply with the pull request guidelines in the section on Contributing Code.

  3. Commit and push your changes.

    Commit messages should follow these guidelines

    Use the following commit message format [Resolves #issue_number] Short description of change.

    e.g. [Resolves #123] Fix description of resolver syntax in documentation

  4. Submit a pull request through the GitHub website.

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

Run unit tests or coverage in your current environment - (handy for quickly running unit tests):

$ make test
$ make coverage

Note: Sceptre aims to be compatible with Python 3, please run unit test against all supported versions. You will need the corresponding versions of Python installed on your system.

Run unit tests and coverage on all supported python versions:

$ make test-all

Tox is used to manage python vresions for running unit tests. If you use pyenv to manage Python versions, try pip install tox-pyenv to make tox and pyenv play nicely.

Integration Tests

If you haven't setup your local environment or personal CircleCI account to run integration tests then follow these steps:

To run on CircleCi (please do this before submitting your PR so we can see that your tests are passing):

  • Login to CircleCi using your Github Account.
  • Click Add Projects, you will be presented with a list of projects from your GitHub Account.
  • On your sceptre fork press the Set Up Project button.
  • You can ignore the setup steps, we already have a CircleCi config file in Sceptre. Click "Start Building".
  • Modify the Project Settings, which can be found by navigating: Builds -> Sceptre and selecting the Settings icon, on the right hand side of the page.
  • Once in the Project Settings section under Permissions select AWS Permissions.
  • Add your Access Key ID and Secret Access Key that is associated with an IAM User from your AWS account. The IAM User will require "Full" permissions for CloudFormation and S3 and Write permissions for STS (AssumeRole). For an example please take a look at the Sceptre CI service user policy

Once you have set up CircleCi any time you commit to a branch in your fork all tests will be run, including integration tests.

You can also (optionally) run the integration tests locally, which is quicker during development.

To run integration tests locally

  • pip install awscli
  • Setup AWS CLI Environment variables to work with an AWS account that you have access to. You can use the same user that you use for CircleCi.
  • pip install behave

Note: All integration tests are setup to run in eu-west-* region. If you prefer to run in a different region you must update the region in each test before running it

run all tests

$ behave integration-tests

run a specific feature

$ behave integration-tests --include <feature-file>

run a specific scenario

$ behave integration-tests -n "<scenario-name>"

Sponsors

  • Sage Bionetworks donated the AWS account for running Sceptre integration tests. Please contact [email protected] for support.
  • GoDaddy donated the domain for hosting the Sceptre project. Please contact [email protected] for support.
  • Cloudreach started the Sceptre project and continuted to maintain it until the ver 2.4 release. It has since been extricated from Cloudreach and has been maintained by members of the Sceptre open source community.

Credits

This document took inspiration from the CONTRIBUTING files of the Atom and Boto3 projects.