Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
ykim-akamai authored Jun 21, 2024
0 parents commit 55e8208
Show file tree
Hide file tree
Showing 10 changed files with 223 additions and 0 deletions.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: ["bug"]
body:
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What should have happened?

- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?

- type: textarea
id: reproduce
attributes:
label: Steps to Reproduce
description: List any custom configurations and the steps to reproduce this error

- type: textarea
id: error
attributes:
label: Error Output
description: If you received an error output that is too long, use Gists
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Enhancement
description: Request a feature
title: "[Feature]: "
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: Description
description: What would you like this feature to do in detail?
validations:
required: true
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/help.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: Help
description: You're pretty sure it's not a bug but you can't figure out why it's not working
title: "[Help]: "
labels: ["help wanted"]
body:
- type: textarea
id: description
attributes:
label: Description
description: What are you attempting to do, what error messages are you getting?
validations:
required: true
38 changes: 38 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# PR Labels
- name: new-feature
description: for new features in the changelog.
color: 225fee
- name: improvement
description: for improvements in existing functionality in the changelog.
color: 22ee47
- name: repo-ci-improvement
description: for improvements in the repository or CI workflow in the changelog.
color: c922ee
- name: bugfix
description: for any bug fixes in the changelog.
color: ed8e21
- name: documentation
description: for updates to the documentation in the changelog.
color: d3e1e6
- name: dependencies
description: dependency updates usually from dependabot
color: 5c9dff
- name: testing
description: for updates to the testing suite in the changelog.
color: 933ac9
- name: breaking-change
description: for breaking changes in the changelog.
color: ff0000
- name: ignore-for-release
description: PRs you do not want to render in the changelog
color: 7b8eac
- name: do-not-merge
description: PRs that should not be merged until the commented issue is resolved
color: eb1515
# Issue Labels
- name: enhancement
description: issues that request a enhancement
color: 22ee47
- name: bug
description: issues that report a bug
color: ed8e21
13 changes: 13 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## 📝 Description

**What does this PR do and why is this change necessary?**

## ✔️ How to Test

**What are the steps to reproduce the issue or verify the changes?**

**How do I run the relevant unit/integration tests?**

## 📷 Preview

**If applicable, include a screenshot or code snippet of this change. Otherwise, please remove this section.**
32 changes: 32 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
changelog:
exclude:
labels:
- ignore-for-release
categories:
- title: ⚠️ Breaking Change
labels:
- breaking-change
- title: 🐛 Bug Fixes
labels:
- bugfix
- title: 🚀 New Features
labels:
- new-feature
- title: 💡 Improvements
labels:
- improvement
- title: 🧪 Testing Improvements
labels:
- testing
- title: ⚙️ Repo/CI Improvements
labels:
- repo-ci-improvement
- title: 📖 Documentation
labels:
- documentation
- title: 📦 Dependency Updates
labels:
- dependencies
- title: Other Changes
labels:
- "*"
31 changes: 31 additions & 0 deletions .github/workflows/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: labeler

on:
push:
branches:
- 'main'
paths:
- '.github/labels.yml'
- '.github/workflows/labeler.yml'
pull_request:
paths:
- '.github/labels.yml'
- '.github/workflows/labeler.yml'

jobs:
labeler:
runs-on: ubuntu-latest
steps:
-
name: Checkout
uses: actions/checkout@v4
-
name: Run Labeler
uses: crazy-max/ghaction-github-labeler@de749cf181958193cb7debf1a9c5bb28922f3e1b
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
yaml-file: .github/labels.yml
dry-run: ${{ github.event_name == 'pull_request' }}
exclude: |
help*
*issue
1 change: 1 addition & 0 deletions CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @linode/dx
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing Guidelines

:+1::tada: First off, we appreciate you taking the time to contribute! THANK YOU! :tada::+1:

We put together the handy guide below to help you get support for your work. Read on!

## I Just Want to Ask the Maintainers a Question

The [Linode Community](https://www.linode.com/community/questions/) is a great place to get additional support.

## How Do I Submit A (Good) Bug Report or Feature Request

Please open a [GitHub issue](../../issues/new/choose) to report bugs or suggest features.

Please accurately fill out the appropriate GitHub issue form.

When filing an issue or feature request, help us avoid duplication and redundant effort -- check existing open or recently closed issues first.

Detailed bug reports and requests are easier for us to work with. Please include the following in your issue:

* A reproducible test case or series of steps
* The version of our code being used
* Any modifications you've made, relevant to the bug
* Anything unusual about your environment or deployment
* Screenshots and code samples where illustrative and helpful

## How to Open a Pull Request

We follow the [fork and pull model](https://opensource.guide/how-to-contribute/#opening-a-pull-request) for open source contributions.

Tips for a faster merge:
* address one feature or bug per pull request.
* large formatting changes make it hard for us to focus on your work.
* follow language coding conventions.
* make sure that tests pass.
* make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/).
* add tests!

## Code of Conduct

This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct).

## Vulnerability Reporting

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.

## Licensing

See the [LICENSE file](/LICENSE) for our project's licensing.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Repository Name

Repository description

## Contribution Guidelines

Want to improve [repository name]? Please start [here](CONTRIBUTING.md).

0 comments on commit 55e8208

Please sign in to comment.