Skip to content

Commit 846cb58

Browse files
authored
Merge pull request #21 from LBGarber/add-issue-forms-contributing
Add issue forms and contributing guidelines
2 parents a70fa0a + a25f61f commit 846cb58

File tree

6 files changed

+120
-0
lines changed

6 files changed

+120
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: input
7+
id: docker-version
8+
attributes:
9+
label: Docker Version
10+
description: What version of Docker are you running? `docker version`
11+
validations:
12+
required: true
13+
14+
- type: textarea
15+
id: error
16+
attributes:
17+
label: Error Output
18+
description: If you received an error output that is too long, use Gists
19+
20+
- type: textarea
21+
id: expected
22+
attributes:
23+
label: Expected Behavior
24+
description: What should have happened?
25+
26+
- type: textarea
27+
id: actual
28+
attributes:
29+
label: Actual Behavior
30+
description: What actually happened?
31+
32+
- type: textarea
33+
id: reproduce
34+
attributes:
35+
label: Steps to Reproduce
36+
description: List any custom configurations and the steps to reproduce this error

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Enhancement
2+
description: Request a feature
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: What would you like this feature to do in detail?
11+
validations:
12+
required: true

.github/ISSUE_TEMPLATE/help.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Help
2+
description: You're pretty sure it's not a bug but you can't figure out why it's not working
3+
title: "[Help]: "
4+
labels: ["help wanted"]
5+
body:
6+
- type: textarea
7+
id: description
8+
attributes:
9+
label: Description
10+
description: What are you attempting to do, what error messages are you getting?
11+
validations:
12+
required: true

.github/dependabot.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: gomod
4+
directory: "/"
5+
schedule:
6+
interval: daily
7+
open-pull-requests-limit: 10

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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://github.com/linode/docker-machine-driver-linode/issues/new/choose) to report bugs or suggest features.
14+
15+
Please accurately fill out the appropriate GitHub issue form.
16+
17+
When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first.
18+
19+
Detailed bug reports and requests are easier for us to work with. Please include the following in your issue:
20+
21+
* A reproducible test case or series of steps
22+
* The version of our code being used
23+
* Any modifications you've made, relevant to the bug
24+
* Anything unusual about your environment or deployment
25+
* Screenshots and code samples where illustrative and helpful
26+
27+
## How to Open a Pull Request
28+
29+
We follow the [fork and pull model](https://opensource.guide/how-to-contribute/#opening-a-pull-request) for open source contributions.
30+
31+
Tips for a faster merge:
32+
* address one feature or bug per pull request.
33+
* large formatting changes make it hard for us to focus on your work.
34+
* follow language coding conventions.
35+
* make sure that tests pass.
36+
* make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/).
37+
* add tests!
38+
39+
## Code of Conduct
40+
41+
This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct).
42+
43+
## Vulnerability Reporting
44+
45+
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.
46+
47+
## Licensing
48+
49+
See the [LICENSE file](/LICENSE) for our project's licensing.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,3 +230,7 @@ Join us at [#linodego](https://gophers.slack.com/messages/CAG93EB2S) on the [gop
230230
## License
231231

232232
[MIT License](LICENSE)
233+
234+
## Contribution Guidelines
235+
236+
Want to improve docker-machine-driver-linode? Please start [here](CONTRIBUTING.md).

0 commit comments

Comments
 (0)