https://github.com/memes/repo-template

Standard repo layout for new personal projects
https://github.com/memes/repo-template

Last synced: 7 days ago
JSON representation

Standard repo layout for new personal projects

• Host: GitHub
• URL: https://github.com/memes/repo-template
• Owner: memes
• License: apache-2.0
• Created: 2020-12-04T22:57:35.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-07T18:10:28.000Z (about 1 month ago)
• Last Synced: 2024-12-07T18:29:59.476Z (about 1 month ago)
• Language: Ruby
• Size: 191 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# repo-template

![GitHub release](https://img.shields.io/github/v/release/memes/repo-template?sort=semver)

![Maintenance](https://img.shields.io/maintenance/yes/2024)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)

This repository contains common settings and actions that I tend to use in my

demos and projects.

## Setup

> NOTE: TODOs are sprinkled in the files and can be used to find where changes

> may be necessary.

1. Use as a template when creating a new GitHub repo, or copy the contents into

   a bare-repo directory.

2. Update `.pre-commit-config.yml` to add/remove plugins as necessary.

3. Modify README.md and CONTRIBUTING.md, change LICENSE as needed.

4. Review GitHub PR and issue templates.

5. If using `release-please` action, make these changes:

   1. In GitHub Settings:

      * _Settings_ > _Actions_ > _General_  > _Allow GitHub Actions to create and approve pull requests_ is checked

      * _Settings_ > _Secrets and Variables_ > _Actions_, and add `RELEASE_PLEASE_TOKEN` with PAT as a _Repository Secret_

   2. Modify [release-please action](.github/workflows/release-please.yml) to have the correct release-type and enable

   3. Reset [version.txt](version.txt) to an empty file or remove if using a different `release-please` type.

6. Remove all [CHANGELOG](CHANGELOG.md) entries.

7. Commit changes.