Skip to content

Commit

Permalink
github: update contributing guidelines
Browse files Browse the repository at this point in the history
The issue template has also been slightly modified
  • Loading branch information
zegl committed Apr 27, 2019
1 parent 5680f88 commit 61ec7fe
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 12 deletions.
56 changes: 56 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to kube-score

👋 Hey, thanks for taking the time to contribute! Your help is appreciated.

## How can I contribute?

### Reporting bugs

Bug reports are always welcome, and should be reported as a [GitHub issue](https://github.com/zegl/kube-score/issues/new/choose).

It's easy to open an issue, all you need to do is to answer the following questions:

1. Which version of kube-score are you using?
2. What did you do?
3. What did you expect to see?
4. What did you see instead?

### Feature requests

Feature requests are always welcome, this should also be done as a [GitHub issue](https://github.com/zegl/kube-score/issues/new/choose).

There is currently no set template for feature requests, but largely the same template as the issues can be used.

Describe the feature that you would like to see as clearly as possible.

If the feature request is related to a new "check", include example objects (in YAML format) that are OK, and that should trigger a failure.

### Contributing code

Code contributions are welcome as GitHub Pull Requests.

#### Good commit messages

kube-score tries to use the same commit message format as [the Go programming language](https://golang.org/doc/contribute.html#commit_messages).

Example of a good commit message:

```
score/container: always add a comment if Container Image Pull Policy fails
Fixes #79
```


The first line of the commit message should contain a short description of the change, prefixed by the primary affected package.

Additional lines can be used if a longer explanation of the change is needed.

Issues should be referenced with the syntax `Fixes #123` or `Updates #123` to track that this change is related to an issue.

#### After submit

After a PR has been opened, the complete set of tests will be run automatically. All tests needs to pass before the PR can be merged.

kube-score is using [bors-ng](https://bors.tech/documentation/) for merging Pull Requests, after the PR has been approved by a maintainer,
the `bors r+` command will be run, this will rebase the PR on master, and run the tests again. If the tests run, the PR will be merged!
22 changes: 10 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,19 @@ about: Create a report to help us improve

---

**Describe the bug**
A clear and concise description of what the bug is.
**Which version of kube-score are you using?**

**To Reproduce**
> kube-score version: [e.g. 0.3.0]
```
Insert a YAML document that triggers the incorrect behaviour
```
**What did you do?**

**Expected behavior**
A clear and concise description of what you expected to happen.
> A complete description of the steps you took to trigger the incorrect behaviour.
> Include Kubernetes object YAML/JSON if you have it
**Version**
kube-score version: [e.g. 0.3.0]
**What did you expect to see?**

> A clear and concise description of what you expected to happen.
**Additional context**
Add any other context about the problem here.
**What did you see instead?**

> A description of what happened, include logs and program output
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,7 @@ go build github.com/zegl/kube-score/cmd/kube-score
# Run all tests
go test -v github.com/zegl/kube-score/...
```

## Contributing?

Do you want to help out? Take a look at the [Contributing Guidelines](./.github/CONTRIBUTING.md) for more info. 🤩

0 comments on commit 61ec7fe

Please sign in to comment.