Skip to content
This repository has been archived by the owner on Jul 19, 2023. It is now read-only.

Latest commit

 

History

History
119 lines (71 loc) · 4.04 KB

CONTRIBUTING.rst

File metadata and controls

119 lines (71 loc) · 4.04 KB

Contributing

Hello! Thank you for choosing to help contribute to one of the Cloudreach OpenSource projects. There are many ways you can contribute and help is always welcome. We simply ask that you follow the following contribution policies.

How to Contribute

Report Bugs

Note: DO NOT include your credentials in ANY code examples, descriptions, or media you make public.

Before submitting a bug, please check our issues page 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.

Remember that this is a volunteer-driven project, and that contributions are welcome.

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 (flake8, pylint).
  • 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. Tests should have 100% code coverage.
  • Is appropriately licensed (Apache 2.0).

Get Started

  1. Fork the aws-cfn-secretstore repository on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.org:your_name_here/aws-cfn-secretstore.git

  3. Install your local copy into a virtual environment. Assuming you have virtualenv installed, this is how you set up your fork for local development:

$ cd aws-cfn-secretstore/
$ # Enable your virtual environment
$ virtualenv env
$ source env/bin/activate
$ # Install python requirements
$ pip install -r requirements.txt
  1. Create a branch for local development:
$ git checkout -b <GitHub issue number>-<short description>
  1. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ make lint
$ make test-all
$ make coverage  # coverage should be 100%
  1. Make sure the changes comply with the pull request guidelines in the section on Contributing Code.
  2. Commit your changes:
$ git add .
$ git commit

Commit messages should follow these guidelines.

Push your branch to GitHub:

$ git push origin <description of pull request>
  1. Submit a pull request through the GitHub website.

Credits

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