Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add issue templates and contributing guide #4

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 🐜 Bug Report
description: Tell us about something not working properly
labels: [ "kind/bug", "priority/needs-triage" ]
body:
- type: markdown
attributes:
value: |
# Bug Report

Thanks for helping make the Kubeflow Notebooks project better!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Thanks for helping make the Kubeflow Notebooks project better!
Thanks for helping to make the Kubeflow Notebooks project better!

- type: checkboxes
attributes:
label: Checks
options:
- label: I have searched the [existing issues](https://github.com/kubeflow/notebooks/issues).
required: true
- label: This issue is NOT security related. (Please [disclose responsibly](https://github.com/kubeflow/notebooks/issues))
required: true
- type: input
id: kubeflow-notebooks-version
attributes:
label: Kubeflow Notebooks Version
placeholder: X.X.X
validations:
required: true
- type: input
id: kubernetes-distribution
attributes:
label: Kubernetes Distribution
ederign marked this conversation as resolved.
Show resolved Hide resolved
description: How are you running Kubernetes?
placeholder: EKS / GKE / AKS / k3d / custom / etc.
validations:
required: true
- type: textarea
id: kubernetes-version
attributes:
label: Kubernetes Version
description: Output of `kubectl version` command.
placeholder: |
Client Version: version.Info{Major:"X", Minor:"XX", GitVersion:"vX.X.X", ...}
Server Version: version.Info{Major:"X", Minor:"XX", GitVersion:"vX.X.X", ...}
render: shell
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: The __context__ the problem occurred in, and an __overview__ of what went wrong.
placeholder: I was trying to... but then...
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: Outputs of commands like `kubectl logs my-pod` or `kubectl describe pods my-pod`.
placeholder: |
* include any relevant log outputs here *
render: shell
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/02_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: 💡 Feature Request
description: Suggest an idea for the project
labels: [ "kind/enhancement", "priority/needs-triage" ]
body:
- type: markdown
attributes:
value: |
# Feature Request

Thanks for helping make the Kubeflow Notebooks project better!
- type: checkboxes
attributes:
label: Checks
options:
- label: I have searched the [existing issues](https://github.com/kubeflow/notebooks/issues).
required: true
- type: textarea
id: motivation
attributes:
label: Motivation
description: What has motivated your request?
placeholder: |
* This is the most important part of the request *

* Help us understand what you are trying to achieve, try to separate it from any implementation you may have in mind *
validations:
required: true
- type: textarea
id: implementation
attributes:
label: Implementation
description: What is your proposed implementation?
placeholder: |
* It's fine to leave this blank if you don't have an implementation already in mind *
- type: checkboxes
attributes:
label: Are you willing & able to help?
options:
- label: I am able to submit a PR!
- label: I can help test the feature!
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
blank_issues_enabled: false
contact_links:
- name: 📓 Documentation Issue
url: https://github.com/kubeflow/notebooks/issues
about: Report an issue with the documentation
- name: 🤔 Questions & Answers (GitHub Discussions)
url: https://github.com/kubeflow/notebooks/issues
about: Ask and answer questions using GitHub Discussions
- name: 🤔 Questions & Answers (Slack #kubeflow-notebooks channel)
url: https://www.kubeflow.org/docs/about/community/
about: Ask and answer questions using Google Groups
- name: 🔒 Security Issues
url: https://github.com/kubeflow/notebooks/issues
about: Responsibly disclose security issues
16 changes: 16 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@

<!--
⚠️ please review https://github.com/kubeflow/notebooks/blob/main/CONTRIBUTING.md

Thank you for contributing to Kubeflow Notebooks!

If there are related issues, please reference them using one of the following:

closes: #ISSUE
related: #ISSUE

Please remember:
- provide enough information so that others can review your pull request
- use a semantic title for your pull request (like "fix: xxxxx" or "feat: xxxxx", see contributing guide)
- the title of your pull request will be used to generate the changelog entry, so make it count!
-->
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Kubeflow Notebooks Contributor Guide

Welcome to the Kubeflow Notebooks project! We'd love to accept your patches and
contributions to this project. Please read the
[contributor's guide in our docs](https://www.kubeflow.org/docs/about/contributing/).

The contributor's guide

* shows you where to find the Contributor License Agreement (CLA) that you need
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* shows you where to find the Contributor License Agreement (CLA) that you need

We have https://developercertificate.org/, not cla. Cla is evil.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ederign btw, don't forget to sign commits ;P

to sign,
ederign marked this conversation as resolved.
Show resolved Hide resolved
* helps you get started with your first contribution to Kubeflow,
* and describes the pull request and review workflow in detail, including the
OWNERS files and automated workflow tool.

## Use Semantic Commits
ederign marked this conversation as resolved.
Show resolved Hide resolved

We use [semantic commits](https://www.conventionalcommits.org/en/v1.0.0/) to help us automatically generate changelogs and release notes.

__The name of your PR must be a semantic commit message__, with one of the following _prefixes_ and one of the following _scopes_:
### Prefixes

ederign marked this conversation as resolved.
Show resolved Hide resolved
- `fix:` (bug fixes)
- `feat:` (new features)
- `improve:` (improvements to existing features)
- `refactor:` (code changes that neither fixes a bug nor adds a feature)
- `revert:` (reverts a previous commit)
- `test:` (adding missing tests, refactoring tests; no production code change)
- `ci:` (changes to CI configuration or build scripts)
- `docs:` (documentation only changes)
- `chore:` (ignored in changelog)

To indicate a breaking change, add `!` after the prefix, e.g. `feat!: my commit message`.

### Scopes

- `nb` (notebooks - web-app, controller, images)
- `pvc` (volumes - web-app, controller)
- `tb` (tensorboards - web-app, controller)
- `ws` (workspaces - frontend, backend, controller,, images)

For example `feat(ws): my commit message`.

## Sign Your Work

To certify you agree to the [Developer Certificate of Origin](https://developercertificate.org/) you must sign-off each commit message using `git commit --signoff`, or manually write the following:
```text
feat(ws): my commit message`

Signed-off-by: John Smith <[email protected]>
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no new line at the end of file