diff --git a/README.md b/README.md index 7516c5e..749d311 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,18 @@ This repository contains documentation, guides, and reference material. ## 📖 Available Documentation +- **[Contribution guidelines](./contributing/)** + Documentation and guides related to infrastructure configuration and best practices. + - [Git](./infrastructure/git.md) + Guidelines for contributing using git + +- **[Infrastructure](./infrastructure/)** + Documentation and guides related to infrastructure configuration and best practices. + - [ACME](./infrastructure/acme.md) + Documentation of the ACME concept. + - [IPV6](./infrastructure/ipv6/ipv6.md) + Documentation of the ipv6 concept. + - **[Keycloak](./keycloak/)** Documentation and guides related to Keycloak configuration and best practices. - [Enforce OTP 2FA for Internal Users](./keycloak/enforce-otp-internal.md) @@ -14,9 +26,3 @@ This repository contains documentation, guides, and reference material. - [Enterprise App Integration with Keycloak](./ms-entra/enterprise-app-keycloak.md) Step-by-step instructions for creating an Enterprise Application in Microsoft Entra (Azure AD) as an identity provider for Keycloak. -- **[Infrastructure](./infrastructure/)** - Documentation and guides related to infrastructure configuration and best practices. - - [IPV6](./infrastructure/ipv6/ipv6.md) - Documentation of the ipv6 concept. - - [ACME](./infrastructure/acme.md) - Documentation of the ACME concept. diff --git a/contributing/git.md b/contributing/git.md new file mode 100644 index 0000000..d0f8ef2 --- /dev/null +++ b/contributing/git.md @@ -0,0 +1,48 @@ +# Contributing Guidelines + +Thank you for your interest in contributing! Please follow these rules to keep our history clean and reviews smooth. + +--- + +## 📝 Commit Guidelines + +### **Sign your commits** + All commits **must** be signed (`git commit -S`) so they show up as **Verified** in Forgejo. + +### **Use Conventional Commit types** + Format: + ```text + (): + + + ``` + +Allowed types: +- `feat` – a new feature +- `fix` – a bug fix +- `chore` – maintenance, tooling, docs, CI, etc. + +Examples: +- `feat(auth): add JWT-based login` +- `fix(api): correct null pointer on user lookup` +- `chore(ci): update Forgejo Actions workflow` + +### **Commit body for complex changes** +If the change is non-trivial: +- Explain *what* and *why* in the body. +- Reference issues with `closes #123` or `refs #123`. + +--- + +## 🔀 Pull Requests (PRs) + +### **Review required** +Every PR must be reviewed and approved by **at least one other contributor** before merging. + +### **Branching** +- Use feature branches: `feature/`, `fix/`, etc. +- Keep PRs focused and avoid mixing unrelated changes. + +### **Commit history** +- Rebase/squash before merging if necessary. +- Keep commits meaningful and clean.