Add community guidelines (#36)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Deploy '...'
+2. Run '...'
+3. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Kubernetes Details (`kubectl version`):**
+Kubernetes version, kubectl version etc.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

CODE_OF_CONDUCT.md

@@ -0,0 +1,70 @@
+# Code of Conduct - Predictive Horizontal Pod Autoscaler
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, 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.
+
+## 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
+* 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
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban
+temporarily or permanently any contributor for other behaviors that they deem
+inappropriate, threatening, offensive, or harmful.
+
+## 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.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
+[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
+[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
+and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).

CONTRIBUTING.md

@@ -0,0 +1,155 @@
+<!-- omit in toc -->
+# Contributing to Predictive Horizontal Pod Autoscaler
+
+First off, thanks for taking the time to contribute! ❤️
+
+All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways
+to help and details about how this project handles them. Please make sure to read the relevant section before making
+your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved.
+The community looks forward to your contributions. 🎉
+
+> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support
+> the project and show your appreciation, which we would also be very happy about:
+> - Star the project
+> - Tweet about it
+> - Refer this project in your project's readme
+> - Mention the project at local meetups and tell your friends/colleagues
+
+<!-- omit in toc -->
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [I Have a Question](#i-have-a-question)
+- [I Want To Contribute](#i-want-to-contribute)
+- [Reporting Bugs](#reporting-bugs)
+- [Suggesting Enhancements](#suggesting-enhancements)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the
+[Predictive Horizontal Pod Autoscaler Code of Conduct](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/blob/master/CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code. Please report unacceptable behavior
+to [email protected].
+
+## I Have a Question
+
+> If you want to ask a question, we assume that you have read the available
+> [Documentation](https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/).
+
+Before you ask a question, it is best to search for existing
+[Issues](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/issues) that might help you. In case you
+have found a suitable issue and still need clarification, you can write your question in this issue. It is also
+advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+- Open an [Issue](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/issues/new).
+- Provide as much context as you can about what you're running into.
+- Provide project and platform versions, depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+## I Want To Contribute
+
+> ### Legal Notice <!-- omit in toc -->
+> When contributing to this project, you must agree that you have authored 100% of the content, that you have the
+> necessary rights to the content and that the content you contribute may be provided under the project license.
+
+### Reporting Bugs
+
+<!-- omit in toc -->
+#### Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to
+investigate carefully, collect information and describe the issue in detail in your report. Please complete the
+following steps in advance to help us fix any potential bug as fast as possible.
+
+- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment
+components/versions (Make sure that you have read the
+[documentation](https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/). If you are looking for
+support, you might want to check [this section](#i-have-a-question)).
+- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there
+is not already a bug report existing for your bug or error in the
+[bug tracker](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/issues?q=label%3Abug).
+- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have
+discussed the issue.
+- Collect information about the bug:
+- Stack trace (Traceback)
+- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+- Possibly your input and the output
+- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Bug Report?
+
+We use GitHub issues to track bugs and errors. If you run into an issue with the project:
+
+- Open an [Issue](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/issues/new). (Since we can't be
+sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+- Explain the behavior you would expect and the actual behavior.
+- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to
+recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem
+and create a reduced test case.
+- Provide the information you collected in the previous section.
+
+Once it's filed:
+
+- A team member will try to reproduce the issue with your provided steps.
+- If the team is able to reproduce the issue the issue will be left to be
+[implemented by someone](#your-first-code-contribution).
+
+### Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Predictive Horizontal Pod Autoscaler,
+**including completely new features and minor improvements to existing functionality**. Following these guidelines will
+help maintainers and the community to understand your suggestion and find related suggestions.
+
+<!-- omit in toc -->
+#### Before Submitting an Enhancement
+
+- Make sure that you are using the latest version.
+- Read the [documentation](https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/) carefully and find
+out if the functionality is already covered, maybe by an individual configuration.
+- Perform a [search](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/issues) to see if the
+enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to
+convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful
+to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider
+writing an add-on/plugin library.
+
+<!-- omit in toc -->
+#### How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as [GitHub issues](https://github.com/jthomperoo/predictive-horizontal-pod-autoscaler/issues).
+
+- Use a **clear and descriptive title** for the issue to identify the suggestion.
+- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
+- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point
+you can also tell which alternatives do not work for you.
+- **Explain why this enhancement would be useful** to most Predictive Horizontal Pod Autoscaler users. You may also
+want to point out the other projects that solved it better and which could serve as inspiration.
+
+## Styleguides
+
+### Commit messages
+
+Commit messages should follow the ['How to Write a Git Commit Message'](https://chris.beams.io/posts/git-commit/) guide.
+
+### Documentation
+
+Documentation should be in plain english, with 120 character max line width.
+
+### Code
+
+Project code should pass the linter and all tests should pass.
+
+### Pull Requests
+
+All pull requests must pass the CI (linting, tests), and be approved by a maintainer. If your pull request changes
+functionality the changes should be documented, both in the `CHANGELOG.md` and the `docs/`.
+
+All pull requests are squashed on merge.
+
+## Attribution
+This guide is based on the **contributing-gen**. [Make your own](https://github.com/bttger/contributing-gen)!

README.md

@@ -13,31 +13,27 @@
 </p>
 
 # Predictive Horizontal Pod Autoscaler
-This is a [Custom Pod Autoscaler](https://www.github.com/jthomperoo/custom-pod-autoscaler); aiming
-to have identical functionality to the Horizontal Pod Autoscaler, however with added predictive
-elements.
+This is a [Custom Pod Autoscaler](https://www.github.com/jthomperoo/custom-pod-autoscaler); building on the Horizontal
+Pod Autoscaler functionality to add predictive capabilities by using various statistical methods.
 
 This uses the
 [Horizontal Pod Autoscaler Custom Pod Autoscaler](https://www.github.com/jthomperoo/horizontal-pod-autoscaler)
 extensively to provide most functionality for the Horizontal Pod Autoscaler parts.
 
 ## How does it work?
 
-This project works by calculating the number of replicas a resource should have, then storing these
-values and using statistical models against them to produce predictions for the future.
-These predictions are compared and can be used instead of the raw replica count calculated by the
-Horizontal Pod Autoscaler logic.
+This project works by calculating the number of replicas a resource should have, then storing these values and using
+statistical models against them to produce predictions for the future. These predictions are compared and can be used
+instead of the raw replica count calculated by the Horizontal Pod Autoscaler logic.
 
 ## Features
 
-* Functionally identical to Horizontal Pod Autoscaler for calculating replica
-  counts without prediction.
-* Choice of statistical models to apply over Horizontal Pod Autoscaler replica
-  counting logic.
+* Functionally identical to Horizontal Pod Autoscaler for calculating replica counts without prediction.
+* Choice of statistical models to apply over Horizontal Pod Autoscaler replica counting logic.
     * Holt-Winters Smoothing
     * Linear Regression
-* Allows customisation of Kubernetes autoscaling options without master node
-  access. Can therefore work on managed solutions such as EKS or GCP.
+* Allows customisation of Kubernetes autoscaling options without master node access. Can therefore work on managed
+solutions such as EKS or GCP.
     * CPU Initialization Period.
     * Downscale Stabilization.
     * Sync Period.
@@ -46,7 +42,8 @@ Horizontal Pod Autoscaler logic.
 
 ## More information
 
-See the [wiki for more information, such as guides and references](https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/).
+See the
+[wiki for more information, such as guides and references](https://predictive-horizontal-pod-autoscaler.readthedocs.io/en/latest/).
 
 ## Developing this project
 ### Environment