Skip to content

Commit

Permalink
Merge pull request #113 from instaclustr/issue-104
Browse files Browse the repository at this point in the history
issue-104, templates for bug reports and feature requests were added
  • Loading branch information
cjrolo authored Sep 24, 2024
2 parents 6d0d03e + 3030d17 commit 8ede10e
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

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

### To Reproduce
Steps to reproduce the behavior:
1.
2.
3.

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

### Environment
Please provide the following details about your environment:

- **Operating System**:
- **Rust Version**: (e.g., 1.64.0)
- **Project Version/Commit**: (e.g., 0.1.0 or specific commit hash)
- **Dependencies**: (e.g., versions of dependencies, if relevant)

### Configuration (if applicable)
Provide any relevant configuration details, such as:

### Configuration File (e.g., `config.toml`)
```toml
# Your configuration here
```

### Docker Setup (if applicable)
Please include any Docker or container-related configuration that is relevant to the bug.

### Topology (if applicable)
```yaml
# Your topology.yaml or equivalent file
```

### Logs and Debug Information
If possible, provide logs or debug information that might help in diagnosing the issue.

```text
# Your log output here
```

### Additional Context
Add any other context about the problem here, including potential workarounds or related issues.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

### Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is.

### Describe the solution you'd like
A clear and concise description of what you want to happen.

### Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

### Additional Context
Add any other context or screenshots about the feature request here.

0 comments on commit 8ede10e

Please sign in to comment.