Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update issue templates #56

Merged
merged 4 commits into from
Dec 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,11 @@ The tests will be executed, and the results will be displayed in the console.

## Support & Contribution

For guidance on support & contribution, see the contributing [guidelines](https://github.com/Ori-Roza/drf-api-action/blob/master/CONTRIBUTING.md).
For guidance on support & contribution, see the [contributing guidelines](https://github.com/Ori-Roza/drf-api-action/blob/master/docs/CONTRIBUTING.md).

## Bug Report

For guidance on how to open a bug, see the [bug report template](https://github.com/Ori-Roza/drf-api-action/blob/master/docs/BUG_REPORT.md).

## Example

Expand Down
30 changes: 30 additions & 0 deletions docs/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
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. Import '...'
2. Call with arguments '....'
3. 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.

**Desktop (please complete the following information):**
- OS: [e.g. Linux]
- Python Version [e.g. 3.11]

**Additional context**
Add any other context about the problem here.
File renamed without changes.
65 changes: 65 additions & 0 deletions docs/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Pull Request

## Description

<!-- Provide a concise description of the changes introduced by this pull request. -->

## Related Issue

<!-- If this pull request addresses a specific issue, reference it by linking to the issue. For example: -->
Closes #IssueNumber

## Changes Made

<!-- List the changes made in this pull request, including new features, modifications, and bug fixes. -->

- Change 1
- Change 2
- ...

## Screenshots (if applicable)

<!-- Include screenshots or gifs that showcase the changes visually. -->

## Checklist

- [ ] I have read the [contribution guidelines](https://github.com/Ori-Roza/drf-api-action/blob/master/docs/CONTRIBUTING.md) and followed the process outlined there.
- [ ] My code follows the project's coding standards.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [ ] The documentation has been updated to reflect the changes.
- [ ] I have added proper labels to the pull request (e.g., bug fix, enhancement).
- [ ] My branch is up-to-date with the base branch.

## Additional Notes

<!-- Provide any additional information that might be helpful for reviewers or testers. -->

## Reviewer Guidelines

<!-- Suggest specific areas or aspects of the code that you would like the reviewers to focus on. -->

- Please pay attention to...
- It would be great if you could check...

## Test Instructions

<!-- Outline step-by-step instructions for testing the changes, especially if the testing process is not straightforward. -->

1. Step 1
2. Step 2
3. ...

## Known Issues

<!-- If there are any known issues or limitations with this pull request, mention them here. -->

## Dependencies

<!-- List any dependencies that this pull request relies on. -->

- Dependency 1
- Dependency 2
- ...

Thank you for contributing to **drf-api-action**!
Loading