Add developer guide & code of conduct (#228)

Closes #226

.gitignore

@@ -5,6 +5,7 @@
 
 __pycache__
 cache
+build
 dist
 htmlcov
 venv

CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+

CONTRIBUTING.md

@@ -0,0 +1,117 @@
+# 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](#code-of-conduct)
+2. [How to Contribute](#how-to-contribute)
+   - [Reporting Bugs](#reporting-bugs)
+   - [Suggesting Enhancements](#suggesting-enhancements)
+3. [Development Setup](#development-setup)
+   - [Prerequisites](#prerequisites)
+   - [Installation](#installation)
+   - [Running Tests](#running-tests)
+4. [Style Guides](#style-guides)
+   - [Git Commit Messages](#git-commit-messages)
+   - [Python Code Style](#python-code-style)
+
+## Code of Conduct
+
+See [Code of Conduct](CODE_OF_CONDUCT.md)
+
+## How to Contribute
+
+### Reporting Bugs
+
+Submit a [GitHub Issue](https://github.com/techservicesillinois/awscli-login/issues).
+
+### Suggesting Enhancements
+
+Submit a [GitHub Issue](https://github.com/techservicesillinois/awscli-login/issues).
+
+## Development Setup
+
+### Prerequisites
+
+- Python 3.8 or higher
+- [GNU Make](https://www.gnu.org/software/make/)
+
+### Installation
+
+1. Fork and clone the project with `git`
+2. (Recommended) Create a Python Virtual Env
+
+	```sh
+	$ python -m venv venv
+	$ source venv/bin/activate
+	```
+
+> Tip: Our `Makefile` expects the command `python` to be aliased to your preferred version of Python3.
+
+3. Build 
+
+	```sh
+	(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.
+
+4. Run the unit tests to verify the environment
+
+	```sh
+	(venv) $ make test
+	...
+
+	Ran 109 tests in 0.889s
+
+	OK
+	```
+
+4. Install
+
+	```sh
+	(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](https://github.com/pyenv/pyenv?tab=readme-ov-file#installation). 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](https://www.python.org/dev/peps/pep-0008/)
+
+[Flake8 lint tool](https://flake8.pycqa.org/en/latest/)
+
+
+
+