mirror of
https://dev.azure.com/hugendubel/ISA/_git/ISA-Frontend
synced 2025-12-28 22:42:11 +01:00
📚 Update review instructions and code style documentation
Enhanced code review guidelines and clarified code style documentation. - 📚 **Docs**: Added emphasis on adherence to review guidelines - 📚 **Docs**: Clarified documentation requirements in code style - 🛠️ **Refactor**: Updated import paths in input controls styles - 📚 **Docs**: Expanded tech stack documentation with new libraries
This commit is contained in:
19
.github/review-instructions.md
vendored
19
.github/review-instructions.md
vendored
@@ -4,6 +4,8 @@
|
||||
|
||||
When conducting a code review, follow these steps to ensure a thorough and constructive process.
|
||||
|
||||
**Ensure that all review guidelines are followed. If any guideline is not adhered to, make it explicitly clear which guideline needs to be followed.**
|
||||
|
||||
## Review Process
|
||||
|
||||
1. 🎯 **Key Issues**
|
||||
@@ -26,20 +28,3 @@ When conducting a code review, follow these steps to ensure a thorough and const
|
||||
- ⚠️ Warnings
|
||||
- 💡 Suggestions
|
||||
- ✅ Good practices
|
||||
|
||||
## Testing Requirements
|
||||
|
||||
- Ensure the code includes appropriate unit tests using Jest and Spectator.
|
||||
- Verify that error cases are tested.
|
||||
- Follow the Arrange-Act-Assert pattern in test cases.
|
||||
|
||||
## Code Style
|
||||
|
||||
- Adhere to the project's [Code Style Guidelines](/docs/code-style.md).
|
||||
- Prioritize TypeScript type safety and Clean Code principles.
|
||||
|
||||
## Additional Notes
|
||||
|
||||
- If the code or question is unclear, ask for clarification before proceeding.
|
||||
- Avoid generic feedback; tailor your review to the specific code or problem.
|
||||
- Keep the current development phase in mind as outlined in [Development Phases](/docs/phases).
|
||||
|
||||
Reference in New Issue
Block a user