Contributing
Contributions are welcome! This project is built using projen, which provides a standardized project structure and development workflow.
Project Structure
Section titled “Project Structure”As a standard projen repository, this project follows established conventions for:
- Code organization and structure
- Testing frameworks and patterns
- Build and deployment pipelines
- Documentation standards
For more information about projen and its conventions, visit the projen documentation.
To speed up local testing, add this to the compiler options of the tsconfig.dev.json
file:
{ "isolatedModules": true}
Getting Started
Section titled “Getting Started”- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature
) - Make your changes
- Run tests to ensure everything works
- Commit your changes (
git commit -m 'Add some amazing feature'
) - Push to the branch (
git push origin feature/amazing-feature
) - Open a Pull Request from your feature branch to the
main
branch of the cdk-express-pipeline repo
Development Guidelines
Section titled “Development Guidelines”- Follow the existing code style and patterns
- Add tests for new functionality
- Update documentation as needed
- Ensure all tests pass before submitting