This repository serves as a template for creating clean and consistent repositories across the entire nlobby4 codebase. It also includes reusable resources like issue templates, contributing guidelines, and other common Markdown files and editor configurations, which streamline repository creation and maintenance.

ⓘ ​[NEWS] ​ 🖿 ​[DEMO] ​ ★ ​[REQUEST FEATURE] ​ ⚠︎ ​[REPORT BUG]​

Table of Contents

1. Usage
   • Existing Repository
   • New Repository
2. Apply These Changes
3. Tools
   • cSpell
   • EditorConfig
   • Keep a Changelog
   • Codecov
   • Markdownlint
   • Markdown All in One
   • Notebooks
   • Dev Containers
   • GitHub CodeSpaces
   • GitHub Actions
   • CodeQL
   • Snyk Security
   • GitLens
   • GitHub Pull Requests
   • Templates
   • dependabot
   • .env with org secrets
   • git lens
   • draw.io

Usage

The markdown files include TODO comments that explain the purpose of each section, along with usage guidelines. These comments can be removed once you have acknowledged their purpose. Depending on the needs of your repository, you can decide whether to keep or remove specific sections or files. Nevertheless, it's still recommended to install the suggested extensions and keep their respective configuration files, see Tools for more information.

Installation

In general there are two ways to utilize this repository:

A. Copy to an Existing Repository

If you already have an existing repository, you can easily copy and paste the specific files you need, or download the repository as a ZIP file here. Alternatively, you can clone the repository using Git.

B. Start a New Repository

This repository is marked as a template, which allows you to select it as one when creating a new repository via GitHub. This will result in all the contained files being copied to your new repository. Once you open the repository in vscode it will prompt you to install the recommended extensions and will automatically apply the workspace settings.

Auto Configuration

TODO: TODO: TODO: TODO: creating a github action to automatically configure

Tip

If you are an organization member, you can also follow the jump-start instructions in the member only organization view for a more complete setup.

[back to top]

---

Apply These Changes

TODO: TODO: TODO: TODO: creating a github action to automatically configure

After adding the template to your project, you will have to make some minor adjustments to ensure everything works correctly. The following table outlines the files you should modify and the changes you need to make:

File	Description
README.md	Replace the header and banner images via the .meta folder if needed Replace the repository URL to your own in the URLs section
AUTHORS	Add contributors and maintainers of the repository
CODEOWNERS	Replace the people or teams responsible for specific paths of the repository
feature_request.yml bug_report.yml	Replace readme-boilerplate with your repository name Adapt the templates if required
LICENSE	Choose a license that fits your project (default: MIT License)
.settings.json	Remove CODEOWNERS from the cSpell.words property
cspell.json	Adapt the used Dictionaries if required

Note

You can remove the LICENSE, TERMS.md, and PRIVACY_POLICY.md files if you are setting up a private repository. However, if you plan to publish your project under an open-source license later, it's recommended to keep them.

[back to top]

---

Tools

This repository includes a set of tools and extensions that help maintain consistency and quality across the codebase. Below is a brief overview of each tool and its purpose:

cSpell

cSpell ensures consistent and proper spelling across all files. You can add or remove dictionaries based on your needs by modifying the cspell.json, furthermore it lets you customize rules and ignored words. When you encounter project-specific terms, be sure to add them to the cSpell.words property in .vscode/setting.json, only add them to the cspell.json if they are used in multiple projects, e.g. nlobby4 or your username.

EditorConfig

The .editorconfig file provides consistent coding styles between different editors and IDEs. It’s a minimal but essential configuration that standardizes indentation, line endings, character sets, and other formatting details. Do not modify this file unless you have a specific formatting policy that applies to your entire team or path.

Keep a Changelog

TODO: TODO: TODO: TODO:

Codecov

TODO: TODO: TODO: TODO:

Markdownlint

markdownlint is a linter for Markdown files. It helps ensure that your Markdown files are consistent and follow best practices. The configuration is contained in .settings.json.

Markdown All in One

TODO: TODO: TODO: TODO:

Notebooks

TODO: TODO: TODO: TODO:

Dev Containers

TODO: TODO: TODO: TODO:

GitHub CodeSpaces

TODO: TODO: TODO: TODO:

GitHub Actions

TODO: TODO: TODO: TODO:

CodeQL

TODO: TODO: TODO: TODO:

Snyk Security

TODO: TODO: TODO: TODO:

GitLens

TODO: TODO: TODO: TODO:

GitHub Pull Requests

TODO: TODO: TODO: TODO:

Templates

TODO: TODO: TODO: TODO:

dependabot

TODO: TODO: TODO: TODO:

.env with org secrets

TODO: TODO: TODO: TODO:

git lens

TODO: TODO: TODO: TODO:

draw.io

You can include visual documentation or diagrams in your project using .drawio files. These diagrams are especially useful for architectural overviews, workflows, or data models. You can place them anywhere in your project by simply creating a file like diagram-name.drawio.

[back to top]

---