-
Notifications
You must be signed in to change notification settings - Fork 40
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from FairwindsOps/rb/paperwork
add paperwork
- Loading branch information
Showing
9 changed files
with
486 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
--- | ||
name: Bug report | ||
about: Let us know about an unexpected error, a crash, or an incorrect behavior. | ||
|
||
--- | ||
### Installation Process | ||
<!--- | ||
Did you install polaris on your local machine, or in a kubernetes cluster? Did you use kubectl, helm, brew, a GitHub release, or the source code? Let us know below. | ||
--> | ||
|
||
### Nova Version | ||
<!--- | ||
Run `nova version` to show the version, and paste the result between the ``` marks below. | ||
If you are not running the latest version of Nova, please try upgrading because your issue may have already been fixed. | ||
--> | ||
|
||
``` | ||
... | ||
``` | ||
|
||
### Expected Behavior | ||
<!-- | ||
What should have happened? | ||
--> | ||
|
||
### Actual Behavior | ||
<!-- | ||
What actually happened? | ||
--> | ||
|
||
### Steps to Reproduce | ||
<!-- | ||
Please list the full steps required to reproduce the issue | ||
--> | ||
|
||
### Additional Context | ||
<!-- | ||
Are there anything atypical about your situation that we should know? | ||
--> | ||
|
||
### References | ||
<!-- | ||
Are there any other GitHub issues (open or closed) or Pull Requests that should be linked here? For example: | ||
- #6017 | ||
--> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
--- | ||
name: Other | ||
about: For misc. tasks like research or continued conversation | ||
title: '' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# x.x.x | ||
* Migrated existing functionality from private repository |
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @kimschles @makoscafee @rbren |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# 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, gender identity and expression, level of experience, | ||
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 [INSERT EMAIL ADDRESS]. 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 [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# Contributing | ||
|
||
Issues, whether bugs, tasks, or feature requests are essential for keeping our projects great. | ||
We believe it should be as easy as possible to contribute changes that get things working in your environment. | ||
There are a few guidelines that we need contributors to follow so that we can keep on top of things. | ||
|
||
## Code of Conduct | ||
|
||
This project adheres to a [code of conduct](CODE_OF_CONDUCT.md). Please review this document before contributing to this project. | ||
|
||
## Sign the CLA | ||
Before you can contribute, you will need to sign the [Contributor License Agreement](https://cla-assistant.io/fairwindsops/nova). | ||
|
||
## Creating a New Issue | ||
|
||
If you've encountered an issue that is not already reported, please create a [new issue](https://github.com/FairwindsOps/nova/issues), choose `Bug Report`, `Feature Request` or `Misc.` and follow the instructions in the template. | ||
|
||
## Getting Started | ||
|
||
We label issues with the ["good first issue" tag](https://github.com/FairwindsOps/nova/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) | ||
if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, | ||
please start a conversation on that issue, and we can help answer any questions as they come up. | ||
|
||
## Setting Up Your Development Environment | ||
### Prerequisites | ||
* A properly configured Golang environment with Go 1.11 or higher | ||
* A Kubernetes cluster defined in `~/.kube/config` (or in a file specified by the `KUBECONFIG` env variable) | ||
|
||
### Installation | ||
* Install the project with `go get github.com/fairwindsops/nova` | ||
* Change into the Nova directory which is installed at `$GOPATH/src/github.com/fairwindsops/nova` | ||
* See the results with `go run main.go find` | ||
|
||
## Running Tests | ||
|
||
The following commands are all required to pass as part of testing: | ||
|
||
``` | ||
go list ./... | grep -v vendor | xargs golint -set_exit_status | ||
go list ./... | grep -v vendor | xargs go vet | ||
go test ./... | ||
``` | ||
|
||
## Creating a Pull Request | ||
|
||
Each new pull request should: | ||
|
||
- Reference any related issues | ||
- Add tests that show the issues have been solved | ||
- Pass existing tests and linting | ||
- Contain a clear indication of if they're ready for review or a work in progress | ||
- Be up to date and/or rebased on the master branch | ||
|
||
## Creating a new release | ||
Tagging a commit will build and push a new Docker image, add a binary to the | ||
[releases page](https://github.com/FairwindsOps/nova/releases), and publish a new Homebrew binary. | ||
|
||
Be sure to add any notes to CHANGELOG.md | ||
|
Oops, something went wrong.