Added PR templates for Backend, Frontend, and Documentation

This commit is contained in:
klein panic
2024-10-31 21:29:04 -04:00
parent 6920b75797
commit c941b01cfa
3 changed files with 75 additions and 0 deletions

View File

@@ -0,0 +1,25 @@
### Backend Update - Pull Request Template
#### Description
- **Briefly describe the purpose of this PR.** Include context about the AI model, web scraping, API, or other backend components that have been added or modified.
#### Key Changes
- **Core Changes:** Summarize the main changes introduced in this PR (e.g., "Added new AI model for XYZ," "Improved scraper efficiency," or "Refactored API calls").
- **Functionality Details:** Provide any specifics about the approach taken and its intended impact on backend performance or functionality.
#### Testing
- **Steps for Testing:** Outline steps to reproduce and verify the change locally or in a test environment.
- **Automated Tests:** If applicable, list any automated tests included or updated in this PR.
#### Related Issues or Tasks
- Closes #<issue_number> (Reference relevant issue/task in the project)
#### Checklist
- [ ] Code follows company code style and guidelines
- [ ] Added necessary comments and docstrings where applicable
- [ ] Added or updated tests
- [ ] This PR is ready for code review and testing
#### Additional Notes
- Include any remaining questions, planned refactoring, or future improvements here.

View File

@@ -0,0 +1,21 @@
### Documentation Update - Pull Request Template
#### Description
- **Summary of Documentation Updates:** Briefly describe the purpose of the documentation changes, including context or background as necessary.
#### Documented Areas
- **Documents Added or Updated:** List specific files or sections updated in this PR (e.g., API documentation, AI model instructions, setup guides).
- **Key Changes or Additions:** Highlight any new sections, figures, or tables added, or notable updates made.
#### Related Issues or Tasks
- Closes #<issue_number> (Link to relevant documentation issue or task)
#### Checklist
- [ ] Follows the style guide for documentation
- [ ] Content is clear, concise, and accurate
- [ ] New diagrams, images, or tables are appropriately referenced and included
- [ ] This PR is ready for review by the documentation team
#### Additional Notes
- Add any further comments, questions, or future documentation plans here.

View File

@@ -0,0 +1,29 @@
### Frontend Update - Pull Request Template
#### Description
- **Describe the purpose of this frontend change**: Briefly explain what UI components, visualizations, or frontend elements are introduced or updated.
#### Key Changes
- **Summary of Changes:** Provide a brief list of the UI elements modified or added (e.g., new visualization charts, dashboards, etc.).
- **User Impact:** Describe how the changes will impact user interactions or the visual presentation of AI results.
#### Screenshots (if applicable)
- **Before:** Insert image here
- **After:** Insert image here
#### Testing
- **Testing Steps:** Provide steps to test the UI changes locally or on staging (e.g., “Navigate to XYZ page to see changes”).
- **Compatibility Checks:** Ensure that the changes display properly across major browsers/devices.
#### Related Issues or Tasks
- Closes #<issue_number> (Reference any frontend-specific issues or tasks)
#### Checklist
- [ ] Code meets frontend design and UX standards
- [ ] Documentation added or updated
- [ ] Visual tests passed across supported browsers
- [ ] This PR is ready for code review and UX testing
#### Additional Notes
- Mention future improvements or refactoring needs here, if any.