README.md

Conceptual Repository

This intends to be a readme-documented, open-source-licensed, semantic-versioned, conventional-committed and changelogged git repository starting point for the development of a brand-new project

A straightforward beginning for an open-source project repository

Table of Contents

See all

• Getting started
  • Development environment
  • Repo publication
• Project specifications
  • Features
  • Folder structure
• Maintenance
• License

Getting started

First of all, from this template,
Name it accordingly and place where it best fits for your team.

Development environment

Make sure you have Git installed:

$ git --version
git version 2.25.1

Thus, clone the recent-created repository locally, and you'll be ready to start developing your project.

Repo publication

After all, you should make this project your own.
Write a good README to present it to the world.
And also ensure to tailor the project license to your needs, as well as assign a suitable maintenance status.

Project specifications

Here some descriptions about this template project:

Features

This project shortens a repository start setup, considering:

• Inclusion of a mature README document, inspired by Standard Readme
• Inclusion of an open-source LICENSE file
• Inclusion of a structured, yet raw, CHANGELOG file
• Compliance with widely-used version control conventions, such as:
  • Semantic Versioning
  • Conventional Commit
  • Keep a Changelog

Folder structure

.
├── .git/                       Version control system folder
├── .gitignore                  VCS ignored files manifest
├── CHANGELOG.md                Release notes description
├── LICENSE                     License file
└── README.md                   Repo readme document

Maintenance

This project is maintained by the author, @artu-hnrq.
Though, minimal or no implementation has been done yet, it's only intended to be a limited example, demo, or proof-of-concept.

License

This project is published under the permissions established by GNU General Public License v3.0.