project-guidelines.md•790 B
# Project Guidelines
## Coding Standards
- Write clean, readable, and well-documented code.
- Follow consistent naming conventions (camelCase for variables, PascalCase for classes).
- Use TypeScript for all source files.
## Collaboration
- Commit changes with clear, descriptive messages.
- Open pull requests for all major changes and request reviews.
- Document any architectural decisions in the project wiki.
## Testing
- Write unit tests for all new features and bug fixes.
- Run the full test suite before pushing changes.
## Security
- Do not hard-code secrets or credentials in the codebase.
- Use environment variables for configuration.
## Communication
- Use the issue tracker for bugs and feature requests.
- Discuss major changes with the team before implementation.