Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

91 lines (58 loc) · 3.17 KB
Raw

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.

Submit a Bug Report

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.

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.
  • Is appropriately licensed (Apache 2.0).

Get Started

  • Clone the repository locally:
    $ git clone git@github.com:cloudreach/aws-lambda-es-cleanup.git
  • Install your local copy into a virtualenv. Assuming you have virtualenv installed, this is how you set up your fork for local development:
    $ cd aws-lambda-es-cleanup/
    $ virtualenv env
    $ source env/bin/activate
    $ pip install -r requirements.txt
    $ pip install -e .
  • Create a branch for local development:
    $ git checkout -b branch-<GitHub issue number>

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

  • Commit your changes:

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

Credits

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