Skip to content

Commit ec4edbd

Browse files
authored
add contribution guidelines
1 parent 6544550 commit ec4edbd

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Thank you for taking interest in contributing to kubectl-neat !
2+
3+
## Issues
4+
5+
- Feel free to open issues for any reason as long as you make it clear if this issue is about a bug/feature/question/comment.
6+
- Please look for existing issues before you open.
7+
- The issue should clearly explain the reason for opening, the proposal if you have any, and any technical information that's relevant.
8+
9+
## Pull Requests
10+
11+
- Every Pull Request should have an associated Issue unless you are fixing a trivial documentation issue.
12+
- Please add the associated Issue in the PR description.
13+
- Describe what the PR does. There's no convention enforced, but please try to be concise and descriptive. Treat the PR description as a commit message. Titles that starts with "fix"/"add"/"improve"/"remove" are good examples.
14+
- There's no need to add or tag reviewers.
15+
- If a reviewer commented on your code, or asked for changes, please remember to mark the discussion as resolved after you address it. PRs with unresolved issues should not be merged (even if the comment is unclear or requires no action from your side).
16+
- Include tests in Go and/or bats if necessary.

0 commit comments

Comments
 (0)