smcnab1 / project-template-repo

Your starting point for streamlined project setups. Jumpstart your development with this versatile template. 🚀📁

Project Template Repo

Jumpstart your development with this versatile template. 🚀📁
Explore the docs »

View Demo · Report Bug · Request Feature

View Contents

Last Updated DATE

• About The Project
  • Features
  • Built with
• Getting started
  • Prerequisites
  • Install
  • Usage
• Back Matter
  • Roadmap
  • Contributing
  • License

About The Project

This repository can be used as a template to load your new repository with ease. Including the following features to save your time in generating new repositories.

(back to top)

Features

• Auto-Update Documentation Links with current repo name
• Update Email Addresses: CODE_OF_CONDUCT, SECURITY.
• Download files & folders from another GitHub Repo
• Generate Markdown styled index file with SEO details
• Generate Table of Contents into README
• Several files already created for you as a template

Built with

• Markdown
• Python
• GitHub Actions
• Shell

(back to top)

Getting started

Prerequisites

Accessible using browser or GitHub mobile application.

Install

1. Click on use template to generate new repository from template.

2. Enter repository name and Description.

3. Generate new repository.

4. Navigate to Settings > Actions > General and set Workflow Permissions to Read and write permissions

Usage

• Repository Link Updater

  • WIP

• License Date Updater

  • WIP

• Code of Conduct Email Updater

  • WIP

• Security Policy Email Updater

  • WIP

• Table of Contents Generator

  • WIP

• Index File Generator

  • WIP

• Combinations

  • WIP

(back to top)

Back Matter

Roadmap

• Finalise Documentation.
• Remove need for config file, all set within Actions.
• Combination Selection instead of individual options.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement" or "feature-request". Don't forget to give the project a star! Thanks again!

1. Fork the Project.
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

This project is licensed under the MIT License.

(back to top)