Skip to content

docs: add templates for issue and pull request #33

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

Merged
merged 1 commit into from
Feb 2, 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
27 changes: 27 additions & 0 deletions issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Description

Provide a clear and concise description of the problem. Include details about the context, what you were doing when the problem occurred and how to reproduce the problem. Include links to any related issues, if any.

## Expected Behavior

Describe the behavior that you expected to see.

## Current Behavior

Describe the current behavior that you are seeing.

## Steps to Reproduce

Provide detailed instructions on how to reproduce the problem. Include information on which test scenarios you tried and how you tested.

## Screenshots

Include screenshots or GIFs that illustrate the problem. This can be especially useful for user interface issues.

## Additional Information

Provide any additional relevant information, such as system settings, software versions, etc.

## Concluding

Remember that the goal of this template is to provide guidance and facilitate communication between developers, so feel free to include any additional information that you find useful. Make sure to check the project's policies and guidelines before opening the issue.
29 changes: 29 additions & 0 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## Description

Provide a clear and concise description of your change. Explain why this change is necessary and how it improves the project. Include links to related issues, if any.

## Proposed Changes

- List specific changes made
- Include modified files and which lines were changed

## How to Test

Provide detailed instructions on how to test the proposed changes. Include information on which test scenarios you covered and how you tested.

## Screenshots

Include screenshots or GIFs that illustrate the proposed changes. This can be especially useful for user interface changes.

## Compliance

- [ ] I have verified that this change complies with our code and contribution policies.
- [ ] I have verified that this change does not cause regressions and does not affect other parts of the code.

## References

List any additional references or documentation that you used when making this change.

## Concluding

Remember that the goal of this template is to provide guidance and facilitate communication between developers, so feel free to include any additional information that you find useful. Make sure to check the project's policies and guidelines before submitting the pull request.