guilhermeborgesbastos / templates

Document templates for open-source projects (README, CONTRIBUTING, GitHub templates)

Embedded Artistry templates

This repository contains templates that are useful for open-source projects, including:

• Documentation (README, CONTRIBUTING, GitHub templates)
• Jenkins CI pipelines, showing both a "CI" build variant and a "nightly" build variant

For more on project documentation:

• Your Project is Great, So Let's Make Your README Great Too
• Get Others Involved in Your Project with a CONTRIBUTING Guide

For more information on these templates:

• Embedded Artistry README Template
• Embedded Artistry CONTRIBUTING Template
• A GitHub Issue Template for Your Projects
• A GitHub Pull Request Template for Your Projects
• A GitHub Pull Request Template for the CCC Process

Resources that can serve as inspiration for creating your own documentation:

• Open Source Contribution Guide
• Source Control Commit Guidelines
• Code Change Control (CCC) Template
• Embedded Artistry's GitHub Process
• Embedded Artistry Code of Conduct