Mika Ayenson
36 lines
1.7 KiB
Markdown
36 lines
1.7 KiB
Markdown
## Bug - Guidelines
|
|
|
|
These guidelines serve as a reminder set of considerations when addressing a bug in the code.
|
|
|
|
### Documentation and Context
|
|
|
|
- [ ] Provide detailed documentation (description, screenshots, reproducing the bug, etc.) of the bug if not already documented in an issue.
|
|
- [ ] Include additional context or details about the problem.
|
|
- [ ] Ensure the fix includes necessary updates to the release documentation and versioning.
|
|
|
|
### Code Standards and Practices
|
|
|
|
- [ ] Code follows established design patterns within the repo and avoids duplication.
|
|
- [ ] Code changes do not introduce new warnings or errors.
|
|
- [ ] Variables and functions are well-named and descriptive.
|
|
- [ ] Any unnecessary / commented-out code is removed.
|
|
- [ ] Ensure that the code is modular and reusable where applicable.
|
|
- [ ] Check for proper exception handling and messaging.
|
|
|
|
### Testing
|
|
|
|
- [ ] New unit tests have been added to cover the bug fix or edge cases.
|
|
- [ ] Existing unit tests have been updated to reflect the changes.
|
|
- [ ] Provide evidence of testing and detecting the bug fix (e.g., test logs, screenshots).
|
|
- [ ] Validate that any rules affected by the bug are correctly updated.
|
|
- [ ] Ensure that performance is not negatively impacted by the changes.
|
|
- [ ] Verify that any release artifacts are properly generated and tested.
|
|
|
|
### Additional Checks
|
|
|
|
- [ ] Ensure that the bug fix does not break existing functionality.
|
|
- [ ] Review the bug fix with a peer or team member for additional insights.
|
|
- [ ] Verify that the bug fix works across all relevant environments (e.g., different OS versions).
|
|
- [ ] Confirm that all dependencies are up-to-date and compatible with the changes.
|
|
- [ ] Confirm that the proper version label is applied to the PR `patch`, `minor`, `major`.
|