Skip to content

Commit

Permalink
Merge pull request #625 from dynamic-entropy/issue_templates
Browse files Browse the repository at this point in the history
Improve issue templates
  • Loading branch information
dynamic-entropy authored Oct 9, 2023
2 parents 6dfe0f9 + c6ea415 commit 674fd85
Show file tree
Hide file tree
Showing 6 changed files with 134 additions and 21 deletions.
38 changes: 33 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,42 @@
---
name: Bug report
about: Create a bug report
title: "[BUG]"
name: Bug Report
about: Create a report to help us improve
labels: bug
assignees: ''

---

**Describe the bug**

A clear and concise description of what the bug is.

**To Reproduce**

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**

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

**Screenshots**

If applicable, add screenshots to help explain your problem.

**Additional context**

Add any other context about the problem here.

**Possible Solution**

If you have a possible solution or workaround, please describe it.

**Related Issues**

List any related issues here.

**Assignees**

Assign this issue to the person responsible for addressing it, if known.
File renamed without changes.
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/development-request.md

This file was deleted.

28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Documentation Issue
about: Report an issue with project documentation
labels: documentation
---

**Documentation Issue**

A clear and concise description of the issue with the documentation.

**Current Documentation (if applicable)**

If possible, provide a link to the current documentation related to the issue.

**Description of the Issue**

Describe the problem or improvement you'd like to see in the documentation.

**Suggested Changes (if known)**

If you have suggestions for how to address the documentation issue, please provide them.

**Assignees**

Assign this issue to the person responsible for updating or maintaining the documentation, if known.

---

37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
name: Feature Request
about: Describe a request for CMSRucio implementation
labels: enhancement
---

**Feature Description**

A clear and concise description of the feature you'd like to request.

**Use Case**

Explain the use case or scenario where this feature would be valuable.

**Current Behavior (if applicable)**

A brief description of how the system currently behaves without the requested feature.

**Desired Behavior**

A clear and concise description of what you'd like to happen with the proposed feature.

**Implementation Ideas (optional)**

If you have any ideas or suggestions on how this feature could be implemented, please share them here.

**Additional Context**

Add any additional context or information that might be relevant to the feature request.

**Assignees**

Assign this issue to the person responsible for considering or implementing the feature, if known.

---


36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/support_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: Question or Support Request
about: Ask a question or seek support
labels: support
---

**Question or Support Request**

A clear and concise description of your question or issue.

**Environment (if applicable)**

Provide details about your environment, such as the operating system, version, and any relevant software versions.

**Steps to Reproduce (if applicable)**

If the issue is reproducible, please provide steps to reproduce it.

**Expected Outcome (if applicable)**

Describe what you expect to happen.

**Actual Outcome (if applicable)**

Describe what is currently happening.

**Additional Context**

Add any additional context or information that might be relevant to your question or issue.

**Assignees**

Assign this issue to someone who can provide assistance, if known.

---

0 comments on commit 674fd85

Please sign in to comment.