https://github.com/thombruce/repo

A template repository for good repository design
https://github.com/thombruce/repo

Last synced: 1 day ago
JSON representation

A template repository for good repository design

• Host: GitHub
• URL: https://github.com/thombruce/repo
• Owner: thombruce
• License: mit
• Created: 2020-04-24T19:45:18.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-27T02:09:46.000Z (over 4 years ago)
• Last Synced: 2024-11-11T21:20:23.503Z (about 1 month ago)
• Size: 67.4 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Repo


Repo | Helvellyn | Credible




















A template repository for good repository design.


## Table of Contents

1. [Files and Folders](#files-and-folders)

2. [Community Profile](#community-profile)

## Files and Folders


.

├── .github

├── CHANGELOG.md

├── CODE_OF_CONDUCT.md

├── CONTRIBUTING.md

├── LICENSE

├── package.json

└── README.md



### .github


.

└── .github



This hidden folder contains GitHub specific files. [Read more](.github/.GITHUB.md#github).

### CHANGELOG.md


.

└── CHANGELOG.md



Based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) by [Olivier Lacan](https://github.com/olivierlacan).

### CODE_OF_CONDUCT.md


.

└── CODE_OF_CONDUCT.md



### CONTRIBUTING.md


.

└── CONTRIBUTING.md



### LICENSE


.

└── LICENSE



The most essential file to let others know that a project is open source and how they are allowed to use it. This repo, for instance, uses the MIT license; you can use the contents privately and commercially and modify them for your own needs.

### package.json


.

└── package.json



The package.json file is used by npm packages to list dependencies. It isn't required, but can be handy to have even if you're not creating an npm package. At minimum, it lists the name and version of the package. It can also contain many other fields, used by different technologies.

### README.md


.

└── README.md



1. Title

2. Related Repositories

3. Quick Deploy Button (Heroky/Netlify/...) if applicable

4. Dev Badges (Version/Build/Coverage/Issues)

5. Community Badges (License/Code of Conduct/Contributing Guide/Discord)

6. Introduction

7. Table of Contents

## Community Profile