diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..42c7444 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,58 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +### Added +- Initial release with core functionality +- Comprehensive documentation +- CI/CD pipeline with security scanning +- Docker support + +### Changed +- N/A + +### Deprecated +- N/A + +### Removed +- N/A + +### Fixed +- N/A + +### Security +- Added security scanning with Trivy and Gitleaks +- Implemented harden-runner for supply chain security + +--- + +## Release Notes Format + +```markdown +## [X.Y.Z] - YYYY-MM-DD + +### Added +- New features + +### Changed +- Changes in existing functionality + +### Deprecated +- Soon-to-be removed features + +### Removed +- Removed features + +### Fixed +- Bug fixes + +### Security +- Security fixes and improvements +``` + +[Unreleased]: https://github.com/donny-devops/node-ts-api-gateway/compare/vX.Y.Z...HEAD diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..59be587 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,83 @@ +# Contributing + +Thank you for considering contributing to this project! This document outlines the process and guidelines. + +## Quick Start + +1. **Fork** the repository +2. **Clone** your fork: `git clone https://github.com/YOUR-USERNAME/node-ts-api-gateway.git` +3. **Create a branch**: `git checkout -b feature/your-feature-name` +4. **Make your changes** and commit with clear messages +5. **Push** to your fork: `git push origin feature/your-feature-name` +6. **Open a Pull Request** with a clear description + +## Development Setup + +```bash +# Clone the repository +git clone https://github.com/donny-devops/node-ts-api-gateway.git +cd node-ts-api-gateway + +# Install dependencies (see README for specifics) +# Example for Python projects: +# pip install -e ".[dev]" + +# Run tests +# See README.md for project-specific test commands +``` + +## Coding Standards + +- Follow the existing code style and conventions +- Write clear, descriptive commit messages +- Add tests for new features +- Update documentation as needed +- Ensure all tests pass before submitting + +## Pull Request Guidelines + +### Before Submitting + +- [ ] Tests pass locally +- [ ] Code follows project style guidelines +- [ ] Documentation updated (if applicable) +- [ ] Commit messages are clear and descriptive +- [ ] Branch is up to date with `main` + +### PR Description Should Include + +- **What** changed and **why** +- **How** to test the changes +- **Related issues** (if any) - use `Fixes #123` or `Closes #456` +- **Breaking changes** (if any) + +## Code Review Process + +1. A maintainer will review your PR within 3-5 business days +2. Address any requested changes +3. Once approved, a maintainer will merge your PR + +## Reporting Issues + +- Use the issue templates when available +- Provide clear steps to reproduce +- Include relevant logs, screenshots, or error messages +- Specify your environment (OS, version, dependencies) + +## Code of Conduct + +This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code. + +## Questions? + +- Open an issue with the `question` label +- Check existing issues and pull requests first +- See [SUPPORT.md](SUPPORT.md) for additional help resources + +## License + +By contributing, you agree that your contributions will be licensed under the same license as the project (see [LICENSE](LICENSE)). + +--- + +**Thank you for helping make this project better!** 🚀 diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..428c0ad --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,61 @@ +# Support + +## Getting Help + +Thank you for using this project! Here are the best ways to get help: + +### 📖 Documentation + +- **README**: Start with the [README.md](README.md) for setup, usage, and examples +- **Issues**: Check [existing issues](../../issues) - your question may already be answered +- **Discussions**: Browse [GitHub Discussions](../../discussions) (if enabled) for Q&A and community support + +### 🐛 Found a Bug? + +1. **Search existing issues** to see if it's already reported +2. If not found, **open a new issue** using the bug report template +3. Include: + - Clear steps to reproduce + - Expected vs actual behavior + - Environment details (OS, versions, dependencies) + - Relevant logs or error messages + +### 💡 Feature Requests + +- Open an issue with the **feature request** template +- Describe the use case and proposed solution +- Check if similar requests exist first + +### 🔒 Security Vulnerabilities + +**Do not open public issues for security vulnerabilities.** + +- See [SECURITY.md](SECURITY.md) for responsible disclosure process +- Email security concerns to the maintainer (see SECURITY.md) + +### ❓ Questions & Discussions + +- **Quick questions**: Open an issue with the `question` label +- **General discussion**: Use GitHub Discussions (if enabled) or reach out to the maintainer +- **Community chat**: Check the README for any community Slack/Discord links + +### 📧 Contact + +For private inquiries or collaboration: +- **GitHub**: [@donny-devops](https://github.com/donny-devops) +- **LinkedIn**: [Adonis Jimenez](https://www.linkedin.com/in/adonis-jimenez-01a42a245/) +- **Email**: See profile or SECURITY.md for contact information + +### ⏱️ Response Times + +- **Issues**: Reviewed within 3-5 business days +- **Pull requests**: Reviewed within 3-5 business days +- **Security reports**: Acknowledged within 24 hours + +### 🤝 Contributing + +Want to help improve this project? See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. + +--- + +**Thank you for being part of this project!**