Skip to content

docs: add contributor and security guidance - #66

Merged
goroyabu merged 1 commit into
mainfrom
docs/issue-16-contributing
Sep 17, 2026
Merged

goroyabu merged 1 commit into
mainfrom
docs/issue-16-contributing

Conversation

@goroyabu

Copy link
Copy Markdown
Owner

Summary

  • add contributor guidance covering project scope, workflow, verification, packaging, documentation, CI, and releases
  • add a security policy using GitHub private vulnerability reporting
  • add focused Issue forms and a pull request template, with README links to the new guidance
  • align the documented merge workflow with the repository setting that permits merge commits only

Related Issue

Closes #16

Verification

  • git diff --cached --check completed without errors before the commit
  • all Issue-form and workflow YAML files were parsed successfully
  • referenced tracked files and relative documentation links were checked
  • confirmed the bug and enhancement labels exist
  • confirmed private vulnerability reporting is enabled
  • confirmed repository description and topics are set
  • confirmed merge commits are the only allowed pull request merge method
  • build and CTest were not run because this change affects documentation, templates, and repository policy only

Impact

No build, runtime, installation, or package behavior changes. Contributors receive explicit workflow and reporting guidance, and GitHub now presents structured Issue and pull request forms.

Documentation

Adds CONTRIBUTING.md and SECURITY.md, and links both from the README.

Checklist

  • The change is focused on one coherent maintenance outcome.
  • Relevant local verification has been run and reported above.
  • User-facing workflows and supported behavior are documented when changed.
  • No downloaded upstream archives, extracted vendor sources, build outputs, or generated files were committed unintentionally.

- Define project scope, contribution workflow, and verification expectations
- Add security reporting guidance and focused Issue and pull request templates
- Link the new guidance from the README
@goroyabu goroyabu added the documentation Improvements or additions to documentation label Sep 17, 2026
@goroyabu
goroyabu merged commit d80f3ff into main Sep 17, 2026
6 checks passed
@goroyabu
goroyabu deleted the docs/issue-16-contributing branch September 17, 2026 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

meta: add contributor and security guidance

1 participant