@@ -61,7 +61,6 @@ The CI runs the following checks:
6161## Making Changes
6262
6363### Code Style
64- - Use 4 spaces for indentation
6564- Follow existing naming conventions
6665- Keep lines under 120 characters
6766- Add comments for complex logic
@@ -74,29 +73,17 @@ The CI runs the following checks:
7473### Pull Request Process
7574
76751 . Fork the repository
77- 2 . Create a feature branch ( ` git checkout -b feature/amazing-feature ` )
76+ 2 . Create a feature branch
78773 . Make your changes
79784 . Run tests locally
80795 . Commit with clear messages
81- 6 . Push to your fork ( ` git push origin feature/amazing-feature ` )
80+ 6 . Push to your fork
82817 . Open a Pull Request from your fork to the main repository
8382
8483### Commit Messages
85- - Use present tense ("Add feature" not "Added feature")
86- - Keep first line under 50 characters
87- - Reference issues if applicable
88-
89- ## Platform-Specific Considerations
90-
91- ### Windows
92- - Test with both MSVC and MinGW
93- - Ensure DbgHelp.dll linking works correctly
94- - Verify SEH handling functions properly
95-
96- ### Linux/macOS
97- - Test signal handlers work correctly
98- - Verify ANSI color detection
99- - Check terminal clearing functions
84+ - Use prefix for PR title ` [Subject]: <PR title> `
85+ - PR description should describe the major changes in bullet-points
86+ - Sqaushed commit title should be the PR title, and the message should be PR description
10087
10188## Adding New Features
10289
@@ -107,20 +94,13 @@ When adding features:
107944 . Add tests covering the new functionality
108955 . Update documentation
10996
110- ## Debugging Tips
111-
112- ### Debugging Grid Display
113- - Set breakpoints in ` GridListener::printGrid() `
114- - Check stream redirection in ` OnTestStart/End `
97+ ## Questions?
11598
116- ### Debugging Crashes
117- - Test signal handlers with example crash tests
118- - Verify backward-cpp integration
119- - Check platform-specific code paths
99+ Feel free to reach out at nircoe@gmail.com
120100
121- ## Questions?
101+ I'm here to help make contributing to logcoe as smooth as possible!
122102
123- Feel free to open an issue for:
103+ Please open an issue for:
124104- Bug reports
125105- Feature requests
126106- Questions about the codebase
0 commit comments