You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.6 KiB
1.6 KiB
Collaboration Guidelines and Codebase Quality Standards
To ensure smooth collaboration and maintain the high quality of our codebase, please adhere to the following guidelines:
Branching Strategy
premain:- Always push your changes to the
premainbranch initially. - This safeguards the
mainbranch from unintentional disruptions. - All tests will be performed on the
premainbranch. - Changes will only be merged into
mainafter several hours or days of rigorous testing.
- Always push your changes to the
experimental:- For large or potentially disruptive changes, use the
experimentalbranch. - This allows for thorough discussion and review before considering a merge into
main.
- For large or potentially disruptive changes, use the
Pre-Pull Request Checklist
Before creating a Pull Request (PR), ensure you have completed the following tests:
Functionality
- Realtime Faceswap:
- Test with face enhancer enabled and disabled.
- Map Faces:
- Test with both options (enabled and disabled).
- Camera Listing:
- Verify that all cameras are listed accurately.
Stability
- Realtime FPS:
- Confirm that there is no drop in real-time frames per second (FPS).
- Boot Time:
- Changes should not negatively impact the boot time of either the application or the real-time faceswap feature.
- GPU Overloading:
- Test for a minimum of 15 minutes to guarantee no GPU overloading, which could lead to crashes.
- App Performance:
- The application should remain responsive and not exhibit any lag.