Skip to content

Latest commit

 

History

History
117 lines (72 loc) · 2.92 KB

CONTRIBUTING.md

File metadata and controls

117 lines (72 loc) · 2.92 KB
Raw

Contributing to awscli-login

Thank you for considering contributing to awscli-login! We are happy to accept your contributions.

Table of Contents

  1. Code of Conduct
  2. How to Contribute
  3. Development Setup
  4. Style Guides

Code of Conduct

See Code of Conduct

How to Contribute

Reporting Bugs

Submit a GitHub Issue.

Suggesting Enhancements

Submit a GitHub Issue.

Development Setup

Prerequisites

Installation

  1. Fork and clone the project with git

  2. (Recommended) Create a Python Virtual Env

    $ python -m venv venv
$ source venv/bin/activate

Tip: Our Makefile expects the command python to be aliased to your preferred version of Python3.

  1. Build

    (venv) $ make deps
(venv) $ make build

Tip: The Makefile may warn about missing setuptools_scm toward the start of the deps step. This can be safely ignored.

  1. Run the unit tests to verify the environment

    (venv) $ make test
...

Ran 109 tests in 0.889s

OK

  2. Install

    (venv) $ pip install .
...
Successfully installed awscli-login-0.2b2.dev79 lxml-5.3.0

Tip: pip install -e . will not work for running integration tests with AWS CLI.

Running Tests

Unit Tests

To run the unit and static tests against your current python run:

$ make test

Testing across supported versions of Python:

The test across multiple supported versions of python install pyenv. Then run the following commands:

$ make .python-version $ make tox

Style Guides

Git Commit Messages

Because we create our 'CHANGELOG.md' from our git logs, we have a standard for our git logs. This standard applies to commits that make it into the `master` branch, so please apply it, in particular, when closing a pull request.

  • First line of the commit should be short and sweet, and customer focused.
  • Commit details should be formatted as a bulleted list, and developer focused.
  • Commit details should include GitHub keywords such as 'Closes #123' to maintain CHANGELOG links to GitHub issue numbers on a separate final un-bulleted line.

Python Code Style

The project uses PEP-8 as enforced by flake8.

PEP-08 Style Guidelines

Flake8 lint tool