Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/noclocks/ghactions

Centralized Repository for Housing No Clock's Re-usable, Customized GitHub Actions and Workflows
https://github.com/noclocks/ghactions

Last synced: 29 days ago
JSON representation

Centralized Repository for Housing No Clock's Re-usable, Customized GitHub Actions and Workflows

Awesome Lists containing this project

README

        

# Generic Project Template

> [!NOTE]
> This is a generic project template that can be used as a starting point for any project.

## Contents

- [Generic Project Template](#generic-project-template)
- [Contents](#contents)
- [Introduction](#introduction)
- [Project Structure](#project-structure)
- [Contributing](#contributing)
- [License](#license)

## Introduction

This is a generic project template that can be used as a starting point for any project.

It includes a basic project structure and default files that can be used to start a new project.

## Root Files

The root of the project contains the following files:

- [`.gitignore`](./.gitignore): A default `.gitignore` file that can be used to ignore common files and directories. Currently it ignores typical files and directories for the following languages or frameworks:
- Windows (i.e. `Thumbs.db`, `desktop.ini`, `.lnk` files, etc.)
- macOS (i.e. `.DS_Store` files)
- Python (i.e. `.venv`, `.pyc`, `.pyo`, etc.)
- Node.js (i.e. `node_modules`, `npm-debug.log`, etc.)

- [`.gitattributes`](./.gitattributes): A default `.gitattributes` file that can be used to specify attributes for the repository. Currently it applies attributes associated with the following languages or frameworks:
- General Commonly Used Attributes
- Markdown
- PowerShell
- Python
- Web Development (i.e. HTML, CSS, JavaScript, etc.)

- [`.editorconfig`](./.editorconfig): A default `.editorconfig` file that can be used to define and maintain consistent coding styles between different editors and IDEs.

- [`LICENSE.md`](./LICENSE.md): No Clocks Default Open Source License: [Unlicense](https://unlicense.org/).

- [`README.template.md`](./README.template.md): A template for the actual project's `README.md` file that can be used to provide information about the project.

- [`CHANGELOG.md`](./CHANGELOG.md): A default `CHANGELOG.md` file that can be used to provide a log of all changes made to the project.

## GitHub

The `.github` directory contains the following files:

- `dependabot.yml`: A default `dependabot.yml` file that can be used to configure Dependabot for the repository.

- `workflows`: A directory that contains GitHub Actions workflows for the repository. Currently it contains the following workflow:

## Project Structure

The project structure is as follows:

```plaintext
.
├── .github
│ └── workflows
│ └── build.yml
├── .gitignore
├── LICENSE

Reneric Repository Template with Default Files and Structure