docs: add files
This commit is contained in:
parent
0767eb51c9
commit
ae5c27f045
15
.gitlab/issue_templates/bug_report_template.md
Normal file
15
.gitlab/issue_templates/bug_report_template.md
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
## Bug report - Summary
|
||||||
|
|
||||||
|
[Provide a brief description of the bug.]
|
||||||
|
|
||||||
|
## Expected Behavior vs Actual Behavior
|
||||||
|
|
||||||
|
[Describe what you expected to happen and what actually happened.]
|
||||||
|
|
||||||
|
## Steps to Reproduce
|
||||||
|
|
||||||
|
[Outline the steps that lead to the bug's occurrence. Be specific and provide a clear sequence of actions.]
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
||||||
|
[Paste links to any related issues or feature requests.]
|
26
.gitlab/issue_templates/documentation_update_template.md
Normal file
26
.gitlab/issue_templates/documentation_update_template.md
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
## Documentation Section
|
||||||
|
|
||||||
|
[Specify the section or page of the documentation that needs updating]
|
||||||
|
|
||||||
|
## Current Information
|
||||||
|
|
||||||
|
[Provide the current information in the documentation that needs to be updated]
|
||||||
|
|
||||||
|
## Proposed Update
|
||||||
|
|
||||||
|
[Describe the proposed update or correction. Be specific about the changes that need to be made]
|
||||||
|
|
||||||
|
## Reason for Update
|
||||||
|
|
||||||
|
[Explain the reason for the documentation update. Include any recent changes, new features, or corrections that necessitate the update]
|
||||||
|
|
||||||
|
## Additional Context
|
||||||
|
|
||||||
|
[Include any additional context or information that can help the documentation team understand the update better]
|
||||||
|
|
||||||
|
## Attachments
|
||||||
|
|
||||||
|
[Attach any files, screenshots, or references that can assist in making the documentation update]
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
40
.gitlab/issue_templates/feature_request_template.md
Normal file
40
.gitlab/issue_templates/feature_request_template.md
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
## Feature Summary
|
||||||
|
|
||||||
|
[Provide a brief and clear summary of the new feature you are requesting]
|
||||||
|
|
||||||
|
## Problem Description
|
||||||
|
|
||||||
|
[Explain the problem or need that this feature aims to address. Be specific about the issues or gaps in the current functionality]
|
||||||
|
|
||||||
|
## Use Case
|
||||||
|
|
||||||
|
[Describe a real-world scenario or use case where this feature would be beneficial. Explain how it would improve the user experience or workflow]
|
||||||
|
|
||||||
|
## Proposed Solution
|
||||||
|
|
||||||
|
[If you have a specific solution in mind, describe it here. Explain how it would work and how it would address the problem described above]
|
||||||
|
|
||||||
|
## Benefits
|
||||||
|
|
||||||
|
[Explain the benefits and advantages of implementing this feature. Highlight how it adds value to the product or improves user satisfaction]
|
||||||
|
|
||||||
|
## Alternatives Considered
|
||||||
|
|
||||||
|
[If you've considered alternative solutions or workarounds, mention them here. Explain why the proposed feature is the preferred option]
|
||||||
|
|
||||||
|
## Impact on Existing Functionality
|
||||||
|
|
||||||
|
[Discuss how the new feature might impact or interact with existing features. Address any potential conflicts or dependencies]
|
||||||
|
|
||||||
|
## Priority
|
||||||
|
|
||||||
|
[Assign a priority level to the feature request based on its importance. Use a scale such as Low, Medium, High]
|
||||||
|
|
||||||
|
## Attachments
|
||||||
|
|
||||||
|
[Include any relevant attachments, such as sketches, diagrams, or references that can help the development team understand your feature request better]
|
||||||
|
|
||||||
|
## Additional Information
|
||||||
|
|
||||||
|
[Provide any additional information that might be relevant to the feature request, such as user feedback, market trends, or similar features in other products]
|
||||||
|
|
28
.gitlab/merge_request_templates/default.md
Normal file
28
.gitlab/merge_request_templates/default.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
## Description
|
||||||
|
|
||||||
|
[Provide a brief description of the changes introduced by this merge request.]
|
||||||
|
|
||||||
|
## Related Issues
|
||||||
|
|
||||||
|
[Cite any related issues or feature requests that are addressed or resolved by this merge request. Use the gitlab syntax for linking issues, for example, `fixes #123` or `closes #123`.]
|
||||||
|
|
||||||
|
## Type of Change
|
||||||
|
|
||||||
|
- Change 1
|
||||||
|
- Change 2
|
||||||
|
|
||||||
|
## Potential side effects
|
||||||
|
|
||||||
|
[Describe any potential side effects or risks of merging this MR.]
|
||||||
|
|
||||||
|
## Screenshots / GIFs (if applicable)
|
||||||
|
|
||||||
|
[Include any relevant screenshots or GIFs to showcase the changes made.]
|
||||||
|
|
||||||
|
## Additional Comments
|
||||||
|
|
||||||
|
[Add any additional comments or information that may be helpful for reviewers.]
|
||||||
|
|
||||||
|
## Definition of Done
|
||||||
|
- [ ] Documentation is up-to-date.
|
||||||
|
|
Loading…
x
Reference in New Issue
Block a user