Merge a68d77f into df6ae92

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making 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 creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to 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 both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at badgerati42@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing to Pode
+
+:star2::tada: First of all, thank you for taking the time and contributing to Pode! :tada::star2:
+
+The following is a set of guidelines for contributing to Pode on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Table of Contents
+
+* [Code of Conduct](#code-of-conduct)
+* [I just have a Question](#i-just-have-a-question)
+* [About Pode](#about-pode)
+* [How to Contribute](#how-to-contribute)
+  * [Issues](#issues)
+  * [Branch Names](#branch-names)
+  * [Pull Requests](#pull-requests)
+  * [Testing](#testing)
+  * [Documentation](#documentation)
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the Pode's [Code of Conduct](../.github/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## I just have a Question
+
+[![Gitter](https://badges.gitter.im/Badgerati/Pode.svg)](https://gitter.im/Badgerati/Pode?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+
+If you have a question, feel free to either ask it on [GitHub Issues](https://github.com/Badgerati/Pode/issues), or head over to Pode's [Gitter](https://gitter.im/Badgerati/Pode?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) channel.
+
+## About Pode
+
+Pode is a PowerShell framework, and the aim is to make it purely PowerShell only with *no* external dependencies. This allows Pode to be very lightweight, and just work out-of-the-box when the module is installed on any platform.
+
+## How to Contribute
+
+When contributing, please try and raise an issue first before working on the issue. This allows us, and other people, to comment and help. If you raise an issue that you're intending on doing yourself, please state this within the issue - to above somebody else picking the issue up.
+
+### Issues
+
+You can raise new issues, for bugs, enhancements, feature ideas; or you can select an issue currently not being worked on.
+
+### Branch Names
+
+Branches should be named after the issue you are working on, such as `Issue-123`.
+
+If you're working on an issue that hasn't been raised (such as a typo, tests, docs, etc), branch names should be descriptive.
+
+### Pull Requests
+
+When you open a new Pull Request, please ensure:
+
+* The Pull Request must be done against the `develop` branch.
+* The title of the Pull Request contains the original issue number (or is descriptive if there isn't one).
+* Details of the change are explained within the description of the Pull Request.
+* Where possible, include examples of how to use (if it's a new feature especially).
+
+Once opened GitHub will automatically run CI on Windows, Linux and MacOS, as well as Code Coverage.
+
+### Testing
+
+Pode has Unit Tests, there are also some Performance Tests but you do not need to worry about them. There are also currently no Integration Tests.
+
+Where possible, please try to create/update new Unit Tests especially for features. Don't worry too much about decreasing the Code Coverage.
+
+The Unit Tests can be found at `/tests/unit/` from the root of the repository.
+
+To run the tests, you will need [`Invoke-Build`](https://github.com/nightroman/Invoke-Build). Once installed, run the following to run the tests:
+
+```powershell
+Invoke-Build Test
+```
+
+### Documentation
+
+Where possible, please add new, or update, Pode's documentation. This documentation is in the form of:
+
+* The main `/docs` directory. These are markdown files that are built using mkdocs. The `/docs/Functions` directory is excluded as these are compiled using PlatyPS.
+* All functions within the `/src/Public` directory need to have documentation.
+
+To see the docs you'll need to have the [`Invoke-Build`](https://github.com/nightroman/Invoke-Build) installed, then you can run the following:
+
+```powershell
+Invoke-Build Docs
+```

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,32 @@
+---
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: 'bug :bug:'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Steps To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,14 @@
+---
+name: Documentation Request
+about: Suggest an edit to Pode's documentation
+title: ''
+labels: 'documentation :book:'
+assignees: ''
+
+---
+
+**Describe the documentation change you'd like**
+A clear and concise description of the edit.
+
+**Additional context**
+Add any other context or screenshots about the enhancement request here.

.github/ISSUE_TEMPLATE/enhancement-request.md

@@ -0,0 +1,17 @@
+---
+name: Enhancement Request
+about: Suggest an enhancement for an existing feature.
+title: ''
+labels: 'enhancement :arrow_up:'
+assignees: ''
+
+---
+
+**Is your enhancement request related to a problem? Please describe.**
+A clear and concise description of what the problem is, or a link/reference to the issue.
+
+**Describe the enhancement you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the enhancement request here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,17 @@
+---
+name: Feature Request
+about: Suggest a new feature for Pode
+title: ''
+labels: 'feature :sunny:'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is, or a link/reference to the issue.
+
+**Describe the feature you'd like**
+A clear and concise description of what you want to happen.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,11 @@
+**Description of what's been changed**
+A clear and concise description of what has been changed.
+
+**Does it fix an existing issue?**
+A link/reference to the GitHub issue.
+
+**Examples**
+If relevant, include any examples of using what you have changed.
+
+**Additional context**
+Add any other context or screenshots about the pull request request here.