Skip to content

Template and Example of a Repo with basic files that can be included for Github 💯%

License

Notifications You must be signed in to change notification settings

devlinjunker/template.github.docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

version
0.10-SNAPSHOT

Template Github 💯 Repo

GitHub License CII Best Practices Summary GitHub last commit

Intro

This is a template project with all of the basic files and directory structure for a Github Repo 💯%

Dependencies/Frameworks

  • GitHub - this template is based on the GitHub completion stats and has a .github/ directory

Quick Setup/Run

Initializiation:

  • Review License File
  • Review and Update Security Policy
    • Provide private way of reporting vulnerabilities?
  • Remove/Replace Logo files in img/ directory
    • If replacing, change logo location in README
  • Update this README and Links with project specific details
    • Reset Version Information
    • Update/Remove Badges
    • Define Dependencies
    • Update Setup Instructions
    • Update Contributing Info
    • Update Code of Conduct
    • Clear and Reset Changelog

Optional:

Start Project:

  • Add Project Build and Configuration Files
  • Start Coding!

Links

Contributors

About

Template and Example of a Repo with basic files that can be included for Github 💯%

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks