Skip to content

Commit

Permalink
Merge branch 'master' into core
Browse files Browse the repository at this point in the history
  • Loading branch information
mdapena committed Dec 15, 2023
2 parents 17b0053 + 73766ae commit 8bc92f4
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

### Initial Checks

- [ ] I have thoroughly checked that this issue has not already been reported.
- [ ] I have searched the project documentation and forums for related issues or solutions.
- [ ] I have checked if the issue can be reproduced with the latest version of the software.
- [ ] I understand that security-related issues should not be reported in public and will submit privately instead.

### Summary

Provide a brief summary of the issue.

### Description

- Include exact commands, code snippets, or actions to reproduce the unexpected behavior.
- Describe what should occur based on how the software is intended to function.
- Detail precisely what went wrong or what unexpected results were observed.

### Environment

- Operating System.
- Pyventus Version.
- Python Version.

### Additional context

Add any other context about the problem here.
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

### Initial Checks

- [ ] I have added a clear and descriptive title to this issue.
- [ ] I have searched Google & GitHub for similar requests and couldn't find anything.
- [ ] I have searched the project documentation thoroughly using the integrated search tool.

### Proposed Feature

Briefly summarize the proposed new feature in 1-2 sentences.

### Description

Provide a more detailed description of the proposed feature and how it would function. Explain what problem this feature
aims to solve and how it may benefit users.

> ***Known Limitations***
> Note any potential edge cases, limitations or technical challenges that may arise with implementing the proposed
> approach. Suggest possible ways to address these issues if applicable.
### Additional Comments

Include any other relevant details, considerations or questions.
28 changes: 28 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Initial Checks

- [ ] The code compiles successfully without any errors or warnings.
- [ ] I have personally tested these changes on my local environment.
- [ ] I have ensured that relevant documentation has been added or updated.
- [ ] I adhere to the project structure and code standards defined in the documentation.
- [ ] My code follows the established coding style guidelines.
- [ ] I have added tests for the new code (if applicable).
- [ ] All existing tests have passed successfully.

## Description

Please provide a detailed explanation of the modifications made in this pull request.
> **Note**:
> Include specific information about the problem or feature being addressed, the approach taken to solve it, and any
> notable considerations or implications of the changes.
## Related Issues (if applicable)

Link any related issues or pull requests using GitHub references (e.g., #123).

## Screenshots (if applicable)

Add any relevant screenshots or images to assist with the review process.

## Additional Notes

Add any additional information or notes for reviewers.

0 comments on commit 8bc92f4

Please sign in to comment.