Skip to content

docs: add issue templates, security policy, and update contributing guide#298

Closed
avoidwork wants to merge 1 commit into
masterfrom
docs/templates
Closed

docs: add issue templates, security policy, and update contributing guide#298
avoidwork wants to merge 1 commit into
masterfrom
docs/templates

Conversation

@avoidwork

Copy link
Copy Markdown
Owner

Summary

Adds comprehensive documentation templates and policies to filesize.js.

Changes

New Files

  • **** — Structured bug report template with reproduction steps, expected vs actual behavior, and environment details
  • **** — Feature request template with motivation, proposed solution, and example usage
  • **** — Security policy with responsible disclosure process, supported versions, and safe harbor statement

Updated Files

  • **** — Enhanced PR template with additional checklist items (JSDoc, CHANGELOG)
  • **** — Added Code Review section with review process, what reviewers look for, and tips

Why

These templates standardize how contributors report issues, request features, and submit PRs. The security policy provides a clear responsible disclosure path. The updated contributing guide makes the review process transparent.

Checklist

  • All templates follow GitHub's template format
  • Security policy aligns with industry best practices
  • Contributing guide updated with code review expectations
  • No code changes — documentation only

@augmentcode

augmentcode Bot commented Jun 26, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: This PR adds GitHub community health docs to standardize how contributors file issues, request features, disclose security issues, and submit PRs.

Changes:

  • Added bug report and feature request templates under .github/ISSUE_TEMPLATE/.
  • Added .github/SECURITY.md outlining supported versions and a responsible disclosure process.
  • Expanded .github/PULL_REQUEST_TEMPLATE.md with checklist items for JSDoc/CHANGELOG and an optional screenshots section.
  • Updated CONTRIBUTING.md to point to issue templates and document the code review process/expectations.
Technical Notes: Documentation-only change; no library/runtime behavior is modified.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review completed. 3 suggestions posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.

Comment thread .github/SECURITY.md

| Version | Supported |
| ------- | ------------------ |
| 6.x | :white_check_mark: |

@augmentcode augmentcode Bot Jun 26, 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.

SECURITY.md lists 6.x as the supported major, but the current package version is 11.0.18; this mismatch could mislead users about which releases receive security fixes.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

Comment thread .github/SECURITY.md
### How to Report

1. **Do not** open a public issue
2. Email security findings to the maintainers

@augmentcode augmentcode Bot Jun 26, 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.

The reporting instructions say to “Email security findings to the maintainers” but don’t provide a specific contact address or an alternative (e.g., GitHub Security Advisories), which may block responsible disclosures.

Severity: medium

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

- [ ] JSDoc comments added/updated
- [ ] CHANGELOG.md updated (if applicable)

## Screenshots (if applicable)

@augmentcode augmentcode Bot Jun 26, 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.

The new “Screenshots (if applicable)” section can conflict with the project rule that PR templates shouldn’t leave sections blank (AGENTS.md 7.4); contributors may need explicit guidance like using N/A when not applicable.

Severity: low

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

@avoidwork avoidwork closed this Jun 26, 2026
@avoidwork avoidwork deleted the docs/templates branch June 26, 2026 01:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant