Skip to content

Commit 6fd9e49

Browse files
add CONTRIBUTING.md and github templates and labels (#133)
1 parent 1f950a7 commit 6fd9e49

6 files changed

+204
-0
lines changed

.github/ISSUE_TEMPLATE.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## General:
2+
3+
* [ ] Have you removed all sensitive information, including but not limited to access keys and passwords?
4+
* [ ] Have you checked to ensure there aren't other open or closed [Pull Requests](../../pulls) for the same bug/feature/question?
5+
6+
----
7+
8+
## Feature Requests:
9+
* [ ] Have you explained your rationale for why this feature is needed?
10+
* [ ] Have you offered a proposed implementation/solution?
11+
12+
----
13+
14+
## Bug Reporting
15+
16+
### Expected Behavior
17+
18+
### Actual Behavior
19+
20+
### Steps to Reproduce the Problem
21+
22+
1.
23+
1.
24+
1.
25+
26+
### Environment Specifications
27+
28+
#### Screenshots, Code Blocks, and Logs
29+
30+
#### Additional Notes
31+
32+
----
33+
34+
For general help or discussion, join the [Kubernetes Slack team](https://kubernetes.slack.com/messages/CD4B15LUR/details/) channel `#linode`. To sign up, use the [Kubernetes Slack inviter](http://slack.kubernetes.io/).
35+
36+
The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support.

.github/PULL_REQUEST_TEMPLATE.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- If this is your first PR, welcome! Please make sure you read the [contributing guidelines](../CONTRIBUTING.md). -->
2+
3+
<!-- Please label this pull request according to what type of issue you are addressing (see ../CONTRIBUTING.md) -->
4+
**What type of PR is this?**
5+
6+
<!--
7+
Add one of the following kinds:
8+
/kind feature
9+
/kind bug
10+
/kind api-change
11+
/kind cleanup
12+
/kind deprecation
13+
/kind design
14+
/kind documentation
15+
-->
16+
17+
**What this PR does / why we need it**:
18+
19+
**Which issue(s) this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close the issue(s) when PR gets merged)*:
20+
Fixes #
21+
22+
**Special notes for your reviewer**:
23+
24+
**TODOs**:
25+
<!-- Put an "X" character inside the brackets of each completed task. Some may be optional depending on the PR. -->
26+
27+
- [ ] squashed commits
28+
- [ ] includes documentation
29+
- [ ] adds unit tests
30+
- [ ] adds or updates e2e tests
31+
32+

.github/dependabot.yml

+22
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,32 @@
11
version: 2
22
updates:
3+
4+
# Go - root directory
35
- package-ecosystem: "gomod"
46
directory: "/"
57
schedule:
68
interval: "weekly"
9+
commit-message:
10+
prefix: ":seedling:"
11+
labels:
12+
- "kind/cleanup"
13+
14+
# Docker
15+
- package-ecosystem: "docker"
16+
directory: "/"
17+
schedule:
18+
interval: "weekly"
19+
commit-message:
20+
prefix: ":seedling:"
21+
labels:
22+
- "kind/cleanup"
23+
24+
# github-actions
725
- package-ecosystem: "github-actions"
826
directory: "/"
927
schedule:
1028
interval: "weekly"
29+
commit-message:
30+
prefix: ":seedling:"
31+
labels:
32+
- "kind/cleanup"

.github/labels.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
- name: added-feature
2+
description: for new features in the changelog.
3+
color: a2eeef
4+
- name: changed
5+
description: for changes in existing functionality in the changelog.
6+
color: a2eeef
7+
- name: deprecated
8+
description: for soon-to-be removed features in the changelog.
9+
color: e4e669
10+
- name: removed
11+
description: for now removed features in the changelog.
12+
color: e4e669
13+
- name: bugfix
14+
description: for any bug fixes in the changelog.
15+
color: d73a4a
16+
- name: security
17+
description: for vulnerabilities in the changelog.
18+
color: dd4739
19+
- name: bug
20+
description: Something isn't working in this issue.
21+
color: d73a4a
22+
- name: enhancement
23+
description: New feature request in this issue.
24+
color: a2eeef

.github/release-drafter.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name-template: 'v$NEXT_PATCH_VERSION'
2+
tag-template: 'v$NEXT_PATCH_VERSION'
3+
categories:
4+
- title: '🚀 Added'
5+
label: 'added-feature'
6+
- title: '🧰 Changed'
7+
label: 'changed'
8+
- title: "⚠️ Deprecated"
9+
label: "deprecated"
10+
- title: "⚠️ Removed"
11+
label: "removed"
12+
- title: '🐛 Bug Fixes'
13+
label: 'bugfix'
14+
- title: "⚠️ Security"
15+
label: "security"
16+
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
17+
no-changes-template: "- No changes"
18+
template: |
19+
## Changes
20+
21+
$CHANGES

CONTRIBUTING.md

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing Guidelines
2+
3+
:+1::tada: First off, we appreciate you taking the time to contribute! THANK YOU! :tada::+1:
4+
5+
We put together the handy guide below to help you get support for your work. Read on!
6+
7+
## I Just Want to Ask the Maintainers a Question
8+
9+
The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support.
10+
11+
## How Do I Submit A (Good) Bug Report or Feature Request
12+
13+
Please open a [github issue](https://guides.github.com/features/issues/) to report bugs or suggest features.
14+
15+
When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first.
16+
17+
Detailed bug reports and requests are easier for us to work with. Please include the following in your issue:
18+
19+
* A reproducible test case or series of steps
20+
* The version of our code being used
21+
* Any modifications you've made, relevant to the bug
22+
* Anything unusual about your environment or deployment
23+
* Screenshots and code samples where illustrative and helpful
24+
25+
## How to Open a Pull Request
26+
27+
We follow the [fork and pull model](https://opensource.guide/how-to-contribute/#opening-a-pull-request) for open source contributions.
28+
29+
Tips for a faster merge:
30+
* address one feature or bug per pull request.
31+
* large formatting changes make it hard for us to focus on your work.
32+
* follow language coding conventions.
33+
* make sure that tests pass.
34+
* make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/).
35+
* add tests!
36+
37+
## Contributing a Patch
38+
39+
1. Fork the desired repo, develop and test your code changes.
40+
1. See the [Development Guide](https://linode.github.io/cluster-api-provider-linode/developers/development.html) for more instructions on setting up your environment and testing changes locally.
41+
2. Submit a pull request.
42+
1. All PRs should be labeled with one of the following kinds
43+
- `/kind feature` for PRs related to adding new features/tests
44+
- `/kind bug` for PRs related to bug fixes and patches
45+
- `/kind api-change` for PRs related to adding, removing, or otherwise changing an API
46+
- `/kind cleanup` for PRs related to code refactoring and cleanup
47+
- `/kind deprecation` for PRs related to a feature/enhancement marked for deprecation.
48+
- `/kind design` for PRs related to design proposals
49+
- `/kind documentation` for PRs related to documentation
50+
- `/kind other` for PRs related to updating dependencies, minor changes or other
51+
2. All code changes must be covered by unit tests and E2E tests.
52+
3. All new features should come with user documentation.
53+
3. Ensure that commit message(s) are be meaningful and commit history is readable.
54+
55+
All changes must be code reviewed. Coding conventions and standards are explained in the official [developer docs](https://github.com/kubernetes/community/tree/master/contributors/devel). Expect reviewers to request that you avoid common [go style mistakes](https://github.com/golang/go/wiki/CodeReviewComments) in your PRs.
56+
57+
In case you want to run our E2E tests locally, please refer to the [E2E Testing](https://linode.github.io/cluster-api-provider-linode/developers/development.html#e2e-testing) guide.
58+
59+
## Code of Conduct
60+
61+
This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct).
62+
63+
## Vulnerability Reporting
64+
65+
If you discover a potential security issue in this project we ask that you notify Linode Security via our [vulnerability reporting process](https://hackerone.com/linode). Please do **not** create a public github issue.
66+
67+
## Licensing
68+
69+
See the [LICENSE file](/LICENSE) for our project's licensing.

0 commit comments

Comments
 (0)