Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
36 lines (26 loc) · 903 Bytes

CONTRIBUTING.md

File metadata and controls

36 lines (26 loc) · 903 Bytes
Raw

Contributing

Thanks for helping improve GitHub Docs Templates.

Good Contributions

  • Add a useful new template.
  • Improve beginner explanations.
  • Fix spelling, grammar, or unclear instructions.
  • Add an example project.
  • Improve placeholders or rename instructions.

Template Rules

  • Use descriptive filenames inside this repository, such as README_minimal.md.
  • Explain the real filename users should use, such as README.md.
  • Use clear placeholders like [PROJECT_NAME].
  • Keep language friendly for beginners.
  • Avoid legal advice in license files.

Pull Requests

  1. Fork the repository.
  2. Create a branch.
  3. Make your change.
  4. Check that links work.
  5. Run node scripts/validate.js if you can.
  6. Open a pull request with a short explanation.

Quality Check

Before opening a pull request, this command can catch common mistakes:

node scripts/validate.js