Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
drmorr0 committed Nov 10, 2023
1 parent 823999d commit b2f4ee0
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 3 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Find a bug? Let us know!
title: ''
labels: ''
assignees: drmorr0

---

<!-- Have a feature request? Please start a discussion instead of creating an issue: https://github.com/acrlabs/simkube/discussions -->

## Describe the bug
A clear and concise description of what the bug is.

## Steps to reproduce
1. Run this command...
2. Make this URL request...
3. Watch this pod...

## Expected behavior
A clear and concise description of what you expected to happen.

## Logs or Metrics
Please include any relevant log lines or metrics screenshots.

## Additional Info
Kubernetes Version:
Environment (kind, EKS, self-managed/hosted, etc.):
Affected components (sk-vnode, sk-cloudprov, sk-ctrl, sk-driver, skctl, sk-tracer):
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/planned-improvement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: Planned Improvement
about: Tracking planned improvements or ongoing work.
title: ''
labels: ''
assignees: ''

---

<!-- Please do not use this template for feature requests; this is for planned or ongoing work on SimKube. To file a feature request, please start a discussion here: https://github.com/acrlabs/simkube/discussions -->

## Description
Please describe the planned improvement in enough detail that someone who is not you could start working on it. Code hints, acceptance criteria, etc., are all encouraged.
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[ ] I certify that this PR does not contain any code that has been generated with GitHub Copilot or any other AI-based
code generation tool, in accordance with this project's policies.

## Description
Please describe what this PR does

## Testing done
- How did you test your changes?
- Does this code require any new tests to be written?

## Additional info
Resolves #xxxx
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,13 @@ Links to relevant documentation are below:

## Contributing

We welcome any and all contributions to the SimKube project! Please open a pull request. We're still figuring out
issue tracking, so for the time being if you found a bug or have a feature request, please start a
[discussion](https://github.com/acrlabs/simkube/discussions). This may change in the future.
We welcome any and all contributions to the SimKube project! Please open a pull request.

If you have a feature request, please start a [discussion](https://github.com/acrlabs/simkube/discussions). Members of
the SimKube team will determine whether the feature should become planned work and how it will be prioritized.

If you've found a bug or are working on a planned improvement, please [open an
issue](https://github.com/acrlabs/simkube/issues)!

### Code of Conduct

Expand All @@ -100,6 +104,11 @@ SimKube is licensed under the [MIT License](./LICENSE). Contributors to this pr
to all contributed material, and agree to license your contributions under the same terms. This is "inbound=outbound",
and is the [GitHub default](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service#6-contributions-under-repository-license).

> [!WARNING]
> Due to the uncertain nature of copyright and IP law, this repository does not accept contributions that have been all
> or partially generated with GitHub Copilot or other LLM-based code generation tools. Please disable any such tools
> before authoring changes to this project.
### Contributor's Guide

Please see the [Contributor's Guide](./docs/contributing.md) for more information on setting up and building SimKube.

0 comments on commit b2f4ee0

Please sign in to comment.