/skel

Well-structure Git repository skeleton

Primary LanguageDockerfileMIT LicenseMIT

⚡ skel

A well-structured Git repository skeleton.

This repository should act as a skeleton for creating well-strucutred repositories (meta!).

I use it as a base when starting a new project and I put it on GitHub to let anyone do so as well.

💻 Usage

To start a new well-structured repository:

  1. Clone this repository
  2. Change anything that does not match your project's needs (e.g. this README!)
  3. Commit your changes
  4. [Optional] Vanish the initial commit of this repo by squashing it with your own commit:
git rebase -i --root HEAD

📋 Reporting issues

Share information about how should people report issues with this repository. It's a good practice to share a couple of tips here and then point people to your CONTRIBUTING.md file, which contains more details on this topic.

🧑‍💻 Development

Here you can enter some information about how is this project developed, like:

  1. Governance / Decision making mechanism
  2. Release cycles

🤝 Contributing

Share information about how should people contribute code to this repository. It's a good practice to share a couple of tips here and then point people to your CONTRIBUTING.md file, which contains more details on this topic.

📁 LICENSE

This project is licensed under the MIT License, as stated in the LICENSE file.

If you contribute code to this project, you are implicitly allowing your code to be distributed under the MIT license. You are also implicitly verifying that all code is your original work.

This repo was edited using SourceLair.