Skip to content

docs: add community health files for A+ portfolio standards #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
donny-devops merged 1 commit into from
Jul 7, 2026
Merged

docs: add community health files for A+ portfolio standards #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

Comment on lines +8 to +31
---

## 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

@amazon-q-developer amazon-q-developer Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Replace the placeholder vX.Y.Z with a valid version tag or remove the comparison link until a first release is published. The current link will return a 404 error.

Suggested change
[Unreleased]: https://github.com/donny-devops/node-ts-api-gateway/compare/vX.Y.Z...HEAD
[Unreleased]:

83 changes: 83 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]"
Comment on lines +21 to +23

@amazon-q-developer amazon-q-developer Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove Python-specific example from a Node.js/TypeScript project. This causes confusion for contributors attempting to set up the development environment.

Suggested change
# Install dependencies (see README for specifics)
# Example for Python projects:
# pip install -e ".[dev]"
# Install dependencies (see README for specifics)
npm install


# Run tests
# See README.md for project-specific test commands
Comment on lines +21 to +26

@gemini-code-assist gemini-code-assist Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This repository is a Node.js/TypeScript project, but the development setup instructions contain Python-specific commands (pip install). Please update these instructions to use Node.js commands (such as npm install and npm test) to match the project's actual tech stack.

Suggested change
# Install dependencies (see README for specifics)
# Example for Python projects:
# pip install -e ".[dev]"
# Run tests
# See README.md for project-specific test commands
# Install dependencies
npm install
# Run tests
npm test

Comment on lines +21 to +26
```

## 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.

@amazon-q-developer amazon-q-developer Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove reference to CODE_OF_CONDUCT.md as this file is not included in the PR and does not exist in the repository. The broken link will confuse contributors.

Suggested change
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code.
This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this code.

@gemini-code-assist gemini-code-assist Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The repository does not currently contain a CODE_OF_CONDUCT.md file, so this relative link will result in a 404 error. Please either add the CODE_OF_CONDUCT.md file to the repository, link to an external Code of Conduct URL, or remove/comment out this section until the file is added.

Suggested change
This project follows the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you agree to uphold this code.
This project follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). By participating, you agree to uphold this code.

Comment on lines +67 to +69

## 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!** 🚀
61 changes: 61 additions & 0 deletions SUPPORT.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
Comment on lines +10 to +11

@gemini-code-assist gemini-code-assist Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Since SUPPORT.md is located in the root directory of the repository (rather than in a .github/ subdirectory), the relative links ../../issues and ../../discussions will resolve incorrectly (resulting in 404 errors on GitHub). Using root-relative paths starting with / will ensure these links resolve correctly to the repository's tabs.

Suggested change
- **Issues**: Check [existing issues](../../issues) - your question may already be answered
- **Discussions**: Browse [GitHub Discussions](../../discussions) (if enabled) for Q&A and community support
- **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)
Comment on lines +33 to +34

@amazon-q-developer amazon-q-developer Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove references to SECURITY.md as this file is not included in the PR and does not exist in the repository. Contributors attempting to report security vulnerabilities will encounter broken links.

Suggested change
- See [SECURITY.md](SECURITY.md) for responsible disclosure process
- Email security concerns to the maintainer (see SECURITY.md)
- Email security concerns to the maintainer at <security_email>
- Use responsible disclosure practices when reporting vulnerabilities

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Provide the private security contact you reference

This new support path tells reporters to email security concerns via SECURITY.md, but the repository's SECURITY.md contains no email address and only says to use GitHub private vulnerability reporting "if enabled" or contact the maintainer directly. In repositories without private vulnerability reporting enabled, a reporter following these instructions is left with no concrete private disclosure channel after being told not to open a public issue.

Useful? React with 👍 / 👎.


### ❓ 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/)

@amazon-q-developer amazon-q-developer Bot Jul 7, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛑 PII Exposure: Replace personal name in LinkedIn URL with a placeholder to avoid exposing personally identifiable information in public documentation.

Suggested change
- **LinkedIn**: [Adonis Jimenez](https://www.linkedin.com/in/adonis-jimenez-01a42a245/)
- **LinkedIn**: [<maintainer_name>](<linkedin_profile_url>)

- **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!**
Loading