Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 13 additions & 12 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
# editorconfig.org
root = true

[*]
charset = utf-8
end_of_line = lf
indent_style = space
indent_size = 4
max_line_length = 120
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
max_line_length=off
trim_trailing_whitespace = false

[*.{yaml,yml}]
max_line_length=off
[*.{yml,yaml}]
indent_size = 2
trim_trailing_whitespace = false

[.gitmodules]
[*.{json,json5}]
indent_size = 2

[*.{js,mjs,cjs,ts,mts,cts,jsx,tsx,css,astro}]
indent_size = 2

[{Makefile,*.mk}]
indent_style = tab

[Dockerfile]
indent_style = tab

[{Makefile,*.mk}]
[.gitmodules]
indent_style = tab

[*.sh]
indent_style = tab
indent_size = 2
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @lazybytez/oss-maintainers
2 changes: 1 addition & 1 deletion .github/renovate.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base"
"config:recommended"
],
"labels": ["C5 - dependencies"],
"dependencyDashboardApproval": true
Expand Down
38 changes: 25 additions & 13 deletions .github/workflows/git.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,41 @@
# Checks for Git branches and commit messages to keep consistency
name: Git

on: ["pull_request"]
on:
pull_request:

permissions:
contents: read
pull-requests: read

jobs:
# Verify that the branch name matches the format
verify_branch_name:
name: Verify Branch Name
runs-on: ubuntu-latest
steps:
- name: Check branch name
uses: deepakputhraya/action-branch-name@master
with:
regex: '([a-zA-Z0-0-])+\/([a-zA-Z0-0-])+'
allowed_prefixes: "feature,fix,hotfix,release,renovate"
ignore: main,develop
env:
BRANCH: ${{ github.head_ref }}
run: |
PATTERN='^(feature|fix|hotfix|release|renovate)/[a-zA-Z0-9-]+'
if [[ "$BRANCH" =~ $PATTERN ]]; then
echo "Branch name '$BRANCH' is valid."
else
echo "::error::Branch name '$BRANCH' does not match the required pattern: prefix/description"
echo "Allowed prefixes: feature, fix, hotfix, release, renovate"
exit 1
fi

# Verify that the commits matches the format
verify_commit_messages:
if: (github.actor!= 'renovate[bot]') && (contains(github.head_ref, 'renovate/github_actions/') == false)
name: Verify Commit Messages
if: github.actor != 'renovate[bot]' && !startsWith(github.head_ref, 'renovate/')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Checkout
uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Run commitlint
uses: wagoid/commitlint-github-action@v4
uses: wagoid/commitlint-github-action@v6
with:
configFile: commitlint.config.cjs
configFile: commitlint.config.mjs
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# OS files
.DS_Store
Thumbs.db

# Editor directories and files
.idea
.vscode
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022 Lazy Bytez
Copyright (c) 2026 Lazy Bytez

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
58 changes: 33 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,65 @@
# General Template

[![gh-commit-badge][gh-commit-badge]][gh-commit]
[![gh-contributors-badge][gh-contributors-badge]][gh-contributors]
[![gh-stars-badge][gh-stars-badge]][gh-stars]
<div align="center">

[![License][gh-license-badge]][gh-license]
[![Last Commit][gh-commit-badge]][gh-commit]
[![Contributors][gh-contributors-badge]][gh-contributors]
[![Stars][gh-stars-badge]][gh-stars]

</div>

## Description

This is a general repository template for all projects done by the organization lazybytez.
You can use it if you want. Just be sure to modify the names and emails.
General repository template for all projects by [Lazy Bytez][gh-team].

This template provides a standardized starting point with:

## Getting started
- Conventional commit enforcement via [commitlint](https://commitlint.js.org/)
- Branch naming validation via GitHub Actions
- Dependency updates via [Renovate](https://docs.renovatebot.com/)
- EditorConfig for consistent formatting
- Security policy and code ownership

tbd
## Getting Started

1. Click **Use this template** on GitHub to create a new repository.
2. Update `commitlint.config.mjs` to add project-specific scopes.
3. Update this `README.md` with your project's details.
4. If your project is not MIT-licensed, replace the `LICENSE` file.

## Contributing

If you want to take part in contribution, like fixing issues and contributing directly to the code base, please visit
the [How to Contribute][gh-contribute] document.

## Useful links
## Useful Links

[License][gh-license] -
[Contributing][gh-contribute] -
[Code of conduct][gh-codeofconduct] -
[Code of Conduct][gh-codeofconduct] -
[Issues][gh-issues] -
[Pull requests][gh-pulls]
[Pull Requests][gh-pulls]

<hr>
<hr>

###### Copyright (c) [Lazy Bytez][gh-team]. All rights reserved | Licensed under the MIT license.

<!-- Variables -->
<!-- Badges -->

[gh-license-badge]: https://img.shields.io/github/license/lazybytez/general-template?style=for-the-badge&colorA=302D41&colorB=a6e3a1
[gh-commit-badge]: https://img.shields.io/github/last-commit/lazybytez/general-template?style=for-the-badge&colorA=302D41&colorB=cba6f7

[gh-commit]: https://github.com/lazybytez/general-template/commits/main

[gh-contributors-badge]: https://img.shields.io/github/contributors/lazybytez/general-template?style=for-the-badge&colorA=302D41&colorB=89dceb
[gh-stars-badge]: https://img.shields.io/github/stars/lazybytez/general-template?style=for-the-badge&colorA=302D41&colorB=f9e2af

[gh-contributors]: https://github.com/lazybytez/general-template/graphs/contributors

[gh-stars-badge]: https://img.shields.io/github/stars/lazybytez?style=for-the-badge&colorA=302D41&colorB=f9e2af
<!-- Links -->

[gh-license]: https://github.com/lazybytez/general-template/blob/main/LICENSE
[gh-commit]: https://github.com/lazybytez/general-template/commits/main
[gh-contributors]: https://github.com/lazybytez/general-template/graphs/contributors
[gh-stars]: https://github.com/lazybytez/general-template/stargazers

[gh-contribute]: https://github.com/lazybytez/.github/blob/main/docs/CONTRIBUTING.md

[gh-license]: https://github.com/lazybytez/general-template/blob/main/LICENSE

[gh-codeofconduct]: https://github.com/lazybytez/.github/blob/main/docs/CODE_OF_CONDUCT.md

[gh-issues]: https://github.com/lazybytez/general-template/issues

[gh-pulls]: https://github.com/lazybytez/general-template/pulls

[gh-team]: https://github.com/lazybytez
29 changes: 29 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Security Policy

## Reporting a Vulnerability

**Please do not open public issues for security vulnerabilities.**

Instead, report vulnerabilities via email to **security@lazybytez.de**.

Include as much of the following as possible:

- Description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if any)

## Response Timeline

- **Acknowledgement:** within 48 hours
- **Initial assessment:** within 5 days
- **Fix or mitigation:** depends on severity

## Supported Versions

Only the latest release is supported with security updates.

## Scope

Third-party dependencies are monitored but not directly maintained by us.
If you find a vulnerability in a dependency, please report it upstream and notify us as well.
17 changes: 0 additions & 17 deletions commitlint.config.cjs

This file was deleted.

26 changes: 26 additions & 0 deletions commitlint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
export default {
extends: ["@commitlint/config-conventional"],
rules: {
"type-enum": [
2,
"always",
[
"feat",
"fix",
"build",
"chore",
"ci",
"docs",
"perf",
"refactor",
"revert",
"style",
"test",
"sec",
],
],
// TODO: extend with project-specific scopes
"scope-enum": [2, "always", ["deps", "devops"]],
"subject-max-length": [2, "always", 50],
},
};
Loading