Skip to content

Commit 2983b12

Browse files
new: Add standard issue templates, contributing guidelines, and release drafter (#225)
This change adds the standard templates for issues, pull requests, and contributing guidelines. Additionally, this pull request adds a release drafter workflow.
1 parent ddf4df1 commit 2983b12

File tree

8 files changed

+167
-0
lines changed

8 files changed

+167
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

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

.github/ISSUE_TEMPLATE/feature.yml

+12
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

+12
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/pull_request_template.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## 📝 Description
2+
3+
**What does this PR do and why is this change necessary?**
4+
5+
## ✔️ How to Test
6+
7+
**What are the steps to reproduce the issue or verify the changes?**
8+
9+
**How do I run the relevant unit/integration tests?**
10+
11+
## 📷 Preview
12+
13+
**If applicable, include a screenshot or code snippet of this change. Otherwise, please remove this section.**

.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

.github/workflows/release-drafter.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Release Drafter
2+
3+
on:
4+
push:
5+
branches:
6+
- main # Preemptive for branch change
7+
8+
jobs:
9+
update_release_draft:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: release-drafter/release-drafter@569eb7ee3a85817ab916c8f8ff03a5bd96c9c83e # pin@v5
13+
with:
14+
config-name: release-drafter.yml
15+
env:
16+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CONTRIBUTING.md

+49
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](../../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.rst

+7
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,10 @@ documentation for this library is out of date or unclear, please
103103

104104
.. _Sphinx: http://www.sphinx-doc.org/en/master/index.html
105105
.. _open an issue: https://github.com/linode/linode_api4-python/issues/new
106+
107+
Contributing
108+
------------
109+
110+
Please follow the `Contributing Guidelines`_ when making a contribution.
111+
112+
.. _Contributing Guidelines: https://github.com/linode/linode_api4-python/blob/master/CONTRIBUTING.md

0 commit comments

Comments
 (0)