Skip to content

Latest commit

 

History

History
104 lines (71 loc) · 6.67 KB

template_guide.md

File metadata and controls

104 lines (71 loc) · 6.67 KB
Raw

Template Guide

This document serves as a comprehensive guide for accessing and utilizing the tier-specific templates within PRG.

  • Each categorized tier – #E5E4E2 Platinum, #FFD700 Gold, #C0C0C0 Silver, and #CD7F32 Bronze – has its own customized repository and README templates that cater to different levels of project complexity and requirements.
  • Consult the Category Guidelines for more information on the different project categories and their respective tiers.

Warning

Be sure to change the templates corresponding PRG Connection File Repository Tier parameter from Optimized to the appropriate category your template is for in order to correctly categorize your repository when using a template. All templates are currently set to the uncategorized "Optimized" option, so be sure to change this.

Warning

Be sure to change or remove the .gitattributes file from this the template repository as well. It's used to classify this template repository as a Markdown file on GitHub only, and is not needed.

Table of Contents

#E5E4E2 Platinum Tier Template


#E5E4E2 PRG Platinum Tier Public Template Repository

Designed for the most ambitious and sophisticated projects, this template transcends the ordinary, offering a comprehensive framework for thorough documentation, advanced feature integration, and high-level project presentation.

#FFD700 Gold Tier Template


#FFD700 PRG Gold Tier Public Template Repository

Tailored for advanced and comprehensive projects, this template includes extensive sections and badges suitable for a robust and detailed presentation.

#C0C0C0 Silver Tier Template


#FFD700 PRG Silver Tier Public Template Repository

Designed for intermediate-level projects, this template balances detail and simplicity, providing a streamlined yet informative layout.

#CD7F32 Bronze Tier Template


#FFD700 PRG Bronze Tier Public Template Repository

Ideal for basic or beginner-level projects, this template focuses on simplicity and ease of use, ensuring a clear and concise project overview.

Using the Templates

To use the above templates, you can do one of two things:

  1. Access the template you want to use by clicking on the appropriate link above, then click the green Use this template button in the top right corner of the repository page.

    • This will create a new repository with the template's contents, which you can then clone to your local machine and edit as needed.
    • Follow the instructions on GitHub Docs: Creating a repository from a template for more information.

  2. Click on the appropriate template link above, then Fork the template repository.

    • When you click New Repository, you will now have an option under Repository template to select the template you just forked.
      • Optionally, you can Clone the template, and mark it as a template when you push it to GitHub.
    • This will create a new repository with the template's contents, which you can then clone to your local machine and edit as needed.
    • View the README Guidelines for more information on how to edit the template's contents.
    • Make sure you update the PRG Connection File to categorize your repository properly as well.

Resources