https://github.com/embeddedartistry/templates

Document templates for open-source projects (README, CONTRIBUTING, GitHub templates)
https://github.com/embeddedartistry/templates

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/embeddedartistry/templates
• Owner: embeddedartistry
• License: mit
• Created: 2017-12-06T04:03:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-10-10T20:21:48.000Z (12 months ago)
• Last Synced: 2024-06-22T21:12:44.448Z (3 months ago)
• Language: Groovy
• Size: 52.7 KB
• Stars: 380
• Watchers: 10
• Forks: 1,428
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - embeddedartistry/templates - Document templates for open-source projects (README, CONTRIBUTING, GitHub templates) (Groovy)

README

        
# Embedded Artistry templates

We like to keep our documentation under revision control and in the same repository as our source code. These templates reflect some of the different types of documentation that we typically include on our projects:

* Common open-source documentation (README, CONTRIBUTING, GitHub templates)

* Architecture and requirements documentation templates

* "Business-level" documentation templates, such as stakeholder profiles, differentiation strategy, and risk profiles

* Jenkins CI pipelines, showing both a "CI" build variant and a "nightly" build variant

We hope these templates enable you to write better documentation for your own projects! 

Updates, edits, and contributions are welcome from all.

## References & Resources

For more on project documentation:

* [Your Project is Great, So Let's Make Your README Great Too](https://embeddedartistry.com/blog/2017/11/27/your-project-is-great-so-lets-make-your-readme-great-too/)

* [Get Others Involved in Your Project with a CONTRIBUTING Guide](https://embeddedartistry.com/blog/2017/12/11/get-others-involved-in-your-project-with-a-contributing-guide/)

For more information on these templates:

* [Embedded Artistry README Template](https://embeddedartistry.com/blog/2017/11/30/embedded-artistry-readme-template/)

* [Embedded Artistry CONTRIBUTING Template](https://embeddedartistry.com/blog/2017/12/14/embedded-artistry-contributing-template/)

* [A GitHub Issue Template for Your Projects](https://embeddedartistry.com/blog/2017/08/18/a-github-issue-template-for-your-projects/)

* [A GitHub Pull Request Template for Your Projects](https://embeddedartistry.com/blog/2017/08/04/a-github-pull-request-template-for-your-projects/)

* [A GitHub Pull Request Template for the CCC Process](https://embeddedartistry.com/blog/2017/08/11/a-github-pull-request-template-for-the-ccc-process/)

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

* [Open Source Contribution Guide](https://embeddedartistry.com/fieldatlas/open-source-contribution-guide/)

* [Source Control Commit Guidelines](https://embeddedartistry.com/fieldatlas/source-control-commit-guidelines/)

* [Code Change Control (CCC) Template](https://embeddedartistry.com/blog/2017/03/10/code-change-control-ccc-template/)

* [Embedded Artistry's GitHub Process](https://embeddedartistry.com/fieldatlas/embedded-artistrys-github-process/)

* [Embedded Artistry Code of Conduct](https://embeddedartistry.com/fieldatlas/embedded-artistry-code-of-conduct/)

#end