Skip to content

Commit

Permalink
chore: added pull request and issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
crazywolf132 committed Dec 2, 2024
1 parent 291b5bc commit 0991811
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

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

## Steps To Reproduce
1. Set up environment with '...'
2. Initialize with '...'
3. Run code '...'
4. See error

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

## Actual Behavior
A clear and concise description of what actually happened.

## Code Example
```go
// Minimal code example that reproduces the issue
```

## Environment
- Go version: [e.g., 1.20.1]
- OS: [e.g., macOS 12.6]
- Package version: [e.g., v1.0.0]
- AWS SDK version: [e.g., v2.0.0]

## Additional Context
Add any other context about the problem here, such as:
- Related issues
- Error messages
- Stack traces
- Log outputs
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

## Problem Statement
A clear and concise description of what problem this feature would solve. Ex. I'm always frustrated when [...]

## Proposed Solution
A clear and concise description of what you want to happen.

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

## Example Usage
```go
// Example code showing how the feature would be used
```

## Benefits
Describe the benefits this feature would bring to users of the package.

## Additional Context
Add any other context, references, or screenshots about the feature request here.
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## Description
Please include a summary of the change and which issue is fixed. Include relevant motivation and context.

Fixes # (issue)

## Type of Change
Please delete options that are not relevant.

- [ ] 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 not work as expected)
- [ ] Documentation update
- [ ] Performance improvement
- [ ] Code cleanup or refactor

## How Has This Been Tested?
Please describe the tests that you ran to verify your changes:

1. Test case description
2. Test coverage details
3. Any specific edge cases considered

## Test Configuration
* Go version:
* OS:
* AWS SDK version (if relevant):

## Checklist
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I have checked my code and corrected any misspellings

## Additional Notes
Add any additional notes about the PR here.

0 comments on commit 0991811

Please sign in to comment.