Skip to content

PerfectPan/project-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Template

A technology-agnostic repository template for starting maintainable, publishable, AI-friendly projects.

Use this template when creating a new project that should have consistent contribution rules, agent instructions, review expectations, and repository hygiene from day one.

Start a New Project

  1. Create a new repository from this template.
  2. Replace this README with the new project's name, purpose, and quick start.
  3. Fill in the project-specific validation commands in AGENTS.md and CONTRIBUTING.md.
  4. Choose the actual implementation stack and add the source layout.
  5. Update CHANGELOG.md for the first release.
  6. Keep or replace LICENSE according to the project needs.

Included

  • AGENTS.md for agent workflow rules.
  • CLAUDE.md for Claude Code entrypoint instructions.
  • CONTRIBUTING.md for human contribution flow.
  • SECURITY.md for vulnerability and sensitive data reporting.
  • .github/pull_request_template.md for PR summaries and validation.
  • .github/ISSUE_TEMPLATE/ for bug and feature reports.
  • rfcs/0000-template.md for substantial design changes.
  • .editorconfig for consistent text formatting.

Template Maintenance

Keep this repository generic. Do not add language-specific package files, framework defaults, generated output, or project-specific business logic.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors