Repository OSS Documentation Templates

A collection of opinionated documentation templates for open-source projects, designed to promote clarity and consistency.

Table of Contents

• Contributing – Guides new contributors on how to get involved, submit pull requests, and follow project standards.
• Code Of Conduct – Establishes community expectations to promote a safe and inclusive environment.
• Pull Request Template(s) – Standardizes pull request submissions to ensure all necessary information is included for efficient review.
• Issue Template(s) – Provides templates for reporting bugs or requesting features consistently.
• Security Policy – Outlines how to responsibly report security vulnerabilities and how the project handles them.
• README – Serves as the main entry point for users, describing the project, setup, usage, and links to other documentation.
• License – Defines how the project can be used, shared, and modified legally.
• Changelog – Tracks and documents notable changes, updates, and releases over time, providing transparency and historical context.

Why This Exists

Maintaining high-quality documentation is important for open-source and all kinds of projects, but writing it from scratch every time can be tedious. This repository provides opinionated templates to help you get started quickly. We also include brief descriptions of each document to explain its purpose and guide you in using them effectively.

Contributing

Contributions are welcome! If you have suggestions for improving templates or adding new ones, please submit a pull request or open an issue.