Skip to content

Commit

Permalink
Updated GitHub templates (#668)
Browse files Browse the repository at this point in the history
  • Loading branch information
sircodemane authored Jun 26, 2024
1 parent 2717df8 commit b092b83
Show file tree
Hide file tree
Showing 3 changed files with 65 additions and 46 deletions.
47 changes: 28 additions & 19 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,52 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
title: 'Bug: '
labels: bug, triage
assignees: ''

---

**Description:**
## Description:

*A clear and concise description of the bug you're encountering.*

**Component(s) Affected:**
### Are you intending to fix this bug?

*Please indicate "yes" or "no".*

## Component(s) Affected:

- [ ] UI
- [ ] API
- [ ] Neo4j
- [ ] PostgreSQL
- [ ] Data Collector (SharpHound, AzureHound)
- [ ] Other (tooling, documentation, etc.)
<!-- Please remove any that don't apply. -->

**Steps to Reproduce:**
- UI
- API
- Neo4j
- PostgreSQL
- Data Collector (SharpHound, AzureHound)
- Other (tooling, documentation, etc.)

## Steps to Reproduce:

1. Go to [specific page or endpoint]
2. Click on [button/element/etc.]
3. Enter [input/data]
4. See error at [this point]

**Expected Behavior:**
## Expected Behavior:

*A description of what you expected to happen.*

**Actual Behavior:**
## Actual Behavior:

*A description of what actually happened.*

**Screenshots/Code Snippets/Sample Files:**
## Screenshots/Code Snippets/Sample Files:

*If applicable, add screenshots, relevant code snippets, or sample files that help illustrate the issue.*

**Environment Information:**
## Environment Information:

<!-- Please use proper version numbers instead of `latest` -->

BloodHound: [BloodHound version or revision]

Expand All @@ -57,19 +64,21 @@ Database (if persistence related): [Neo4j version / PostgreSQL version]

Docker (if using Docker): [docker version]

**Additional Information:**
## Additional Information:

*Any additional context or information that might be helpful in understanding and diagnosing the issue.*

**Potential Solution (Optional):**
## Potential Solution (optional):

*If you have any ideas about what might be causing the issue or how it could be fixed, you can share them here.*

**Related Issues:**
## Related Issues:

*If you've found related issues in the project's issue tracker, mention them here.*

**Contributor Checklist:**
## Contributor Checklist:

<!-- Please remove items that don't apply. -->

- [ ] I have searched the issue tracker to ensure this bug hasn't been reported before or is not already being addressed.
- [ ] I have provided clear steps to reproduce the issue.
Expand Down
19 changes: 11 additions & 8 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,35 @@
---
name: Feature Request
about: Suggest an idea for this project
title: ''
title: 'Feature: '
labels: enhancement, triage
assignees: ''

---

**Feature Description:**
## Feature Description

*Provide a clear and concise description of the feature you're requesting.*

**Current Behavior:**
### Are you intending to implement this feature?

*Please indicate "yes" or "no".*

## Current Behavior

*Explain how the software behaves currently in relation to the feature you're requesting.*

**Desired Behavior:**
## Desired Behavior

*Describe how you envision the software behaving after the proposed feature is implemented.*

**Use Case:**
## Use Case

*Explain the context in which this feature would be useful. How will it benefit users or contributors?*

**Implementation Suggestions:**
## Implementation Suggestions

*Optional: If you have any suggestions on how this feature could be implemented, you can provide them here.*

**Additional Information:**
## Additional Information

*Include any other relevant information that could help in understanding or implementing the feature.*
45 changes: 26 additions & 19 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,42 @@
<!-- README -->
<!-- All pull requests require either an associated -->
<!-- Jira ticket or GitHub issue. PRs opened without -->
<!-- an associated discussion item will be closed! -->

## Description

<!--- Describe your changes in detail -->
*Describe your changes in detail*

## Motivation and Context

<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
This PR addresses: [GitHub issue or Jira ticket number]

*Why is this change required? What problem does it solve?*

## How Has This Been Tested?

<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->
*Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.*

## Screenshots (if appropriate):
## Screenshots (optional):

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
<!-- Please remove any items that do no apply. -->

- [ ] Chore (a change that does not modify the application functionality)
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- Chore (a change that does not modify the application functionality)
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (fix or feature that would cause existing functionality to change)
- Database Migrations

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] Documentation updates are needed, and have been made accordingly.
- [ ] I have added and/or updated tests to cover my changes.
- [ ] All new and existing tests passed.
- [ ] My changes include a database migration.
<!-- Please make sure to you have completed all following checks. -->
- [ ] I have ensured that related documentation is up-to-date
- Open API docs
- Code comments (GoDocs / JSDocs)
- [ ] I have followed proper test practices
- Added/updated tests to cover my changes
- All new and existing tests passed

0 comments on commit b092b83

Please sign in to comment.