From d7f0aac82d106ee13a1526b3bb8f48d361e7b419 Mon Sep 17 00:00:00 2001 From: Eder Ignatowicz Date: Thu, 9 May 2024 08:16:12 -0400 Subject: [PATCH 1/6] add CONTRIBUTING.md, pull_request_template.md and ISSUE_TEMPLATE. Signed-off-by: Eder Ignatowicz --- .github/ISSUE_TEMPLATE/01_bug_report.yml | 60 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02_feature_request.yml | 40 +++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 14 +++++ .github/pull_request_template.md | 16 +++++ CONTRIBUTING.md | 42 +++++++++++++ 5 files changed, 172 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01_bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/02_feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE/01_bug_report.yml b/.github/ISSUE_TEMPLATE/01_bug_report.yml new file mode 100644 index 00000000..9a144044 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01_bug_report.yml @@ -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! + - 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 + 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 \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/02_feature_request.yml b/.github/ISSUE_TEMPLATE/02_feature_request.yml new file mode 100644 index 00000000..0a15e5ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02_feature_request.yml @@ -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! \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..606ec457 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -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 \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..7d943077 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,16 @@ + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..3143bbd6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# 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 + to sign, +* 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 + +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: + +- `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`. + +Please do NOT include a scope, as we do not use them, for example `feat(feature_name): 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 +This is my commit message + +Signed-off-by: John Smith +``` \ No newline at end of file From 3ccbd1cf29592106d0c92c8df7099d6706af8c38 Mon Sep 17 00:00:00 2001 From: Eder Ignatowicz Date: Wed, 29 May 2024 07:03:29 -0400 Subject: [PATCH 2/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jiri Daněk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3143bbd6..4de447d6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,7 @@ Please do NOT include a scope, as we do not use them, for example `feat(feature_ 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 -This is my commit message +feat(ws): my commit message` Signed-off-by: John Smith ``` \ No newline at end of file From 7f8e029540f27f4c49f2abca1e7688b90051d228 Mon Sep 17 00:00:00 2001 From: Eder Ignatowicz Date: Wed, 29 May 2024 07:03:38 -0400 Subject: [PATCH 3/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jiri Daněk --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4de447d6..6dbeaaa9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,7 +16,7 @@ The contributor's guide 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: +__The name of your PR must be a semantic commit message__, with one of the following _prefixes_ and one of the following _scopes_: - `fix:` (bug fixes) - `feat:` (new features) From d8c094657a41d5e4f4b740abbb3b5ce59f65b0b8 Mon Sep 17 00:00:00 2001 From: Eder Ignatowicz Date: Wed, 29 May 2024 07:03:52 -0400 Subject: [PATCH 4/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jiri Daněk --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6dbeaaa9..a8c45832 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,7 @@ The contributor's guide 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 - `fix:` (bug fixes) - `feat:` (new features) From f443f16c938d4f23685ac3ec9d27c1b0b1cc61d2 Mon Sep 17 00:00:00 2001 From: Eder Ignatowicz Date: Wed, 29 May 2024 07:04:01 -0400 Subject: [PATCH 5/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jiri Daněk Signed-off-by: Eder Ignatowicz --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a8c45832..7c709729 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,14 @@ __The name of your PR must be a semantic commit message__, with one of the follo To indicate a breaking change, add `!` after the prefix, e.g. `feat!: my commit message`. -Please do NOT include a scope, as we do not use them, for example `feat(feature_name): 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 From 7af13f247552e5b75e67607b4b177ea131114599 Mon Sep 17 00:00:00 2001 From: Eder Ignatowicz Date: Wed, 29 May 2024 08:58:48 -0400 Subject: [PATCH 6/6] Update CONTRIBUTING.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Jiri Daněk --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c709729..529eeafb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,7 +7,6 @@ contributions to this project. Please read the The contributor's guide * shows you where to find the Contributor License Agreement (CLA) that you need - to sign, * 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.