docs: add SECURITY.md, CONTRIBUTING.md, update maintainer name

2026-07-06 20:02:17 +02:00
parent 5b4aade95f
commit 87518fba99
3 changed files with 89 additions and 1 deletions
@@ -4,7 +4,7 @@
 Lest thy soul be marked with the sigil of a false prophet, thou shalt kneel and recite:

 ```bash
-git config user.name "Celestia Ludenberg"
+git config user.name "Michał"
 git config user.email "ash8820@proton.me"
 ```

@@ -0,0 +1,58 @@
+# Contributing to Antergos NeXT
+
+## Who's behind this
+
+This project is maintained **solo** by Michał (c-ludenberg). I'm recovering from an ankle injury, so updates may be slow. Contributions are genuinely appreciated — they keep the project moving when I can't.
+
+## How to contribute
+
+### Issues
+
+- **Bug reports**: Include the ISO build date, commit SHA, and steps to reproduce. Run Calamares with `-D8` for debug logs.
+- **Feature requests**: Explain what you want and why. PRs are better than requests.
+- **Questions**: If it's about using the ISO, check the [docs](https://antergos-next.github.io/antergos-iso/) first.
+
+### Pull requests
+
+1. Fork the repo, create a branch from `master`.
+2. Make your changes. Keep commits small and signed (`git commit -S`).
+3. Test your changes by building the ISO locally if possible.
+4. Open a PR with a clear description of what and why.
+
+### Before committing
+
+This repo requires **GPG-signed commits**. Set up your key:
+
+```bash
+git config user.signingkey <your-key>
+git config commit.gpgsign true
+```
+
+## Building locally
+
+```bash
+export WORKSPACE_DIR="$PWD"
+mkdir -p ~/.config/artools/pacman.conf.d
+cp pacman.conf.d/iso-x86_64.conf ~/.config/artools/pacman.conf.d/
+sudo -E ./buildiso -p antergos
+```
+
+Use `./buildiso`, not the system `/usr/bin/buildiso` — the system one lacks `--overwrite='*'` and will fail with file conflicts.
+
+## Key gotchas
+
+- **`componentName` in `branding.desc` must match its directory name.** Calamares will bail if they don't match.
+- **Package order in `profile.yaml` matters.** `calamares` must be before `calamares-branding-antergos-next` so branding overwrites defaults.
+- **`[antergos-pkgs]` must be first in `iso-x86_64.conf`.** Custom packages take priority over Artix's.
+- **Copy pacman.conf before building.** `buildiso` uses `~/.config/artools/pacman.conf.d/iso-x86_64.conf`. Without it, it falls back to the system one which lacks the custom repo.
+- **`CMAKE_DISTRIBUTION_NAME` is a no-op.** Calamares ignores it. The "for <distro>" text comes from `versionedName` in the active branding.
+
+## Code style
+
+- Match the surrounding code. No changes are too small to be worth a PR.
+- No unnecessary comments. Code should speak for itself.
+- Keep YAML clean — two-space indentation, no trailing whitespace.
+
+## Getting help
+
+Open a discussion or ping the maintainer. If it's urgent, mention it. If it's not, be patient — I'll get to it.
@@ -0,0 +1,30 @@
+# Security Policy
+
+## Supported Versions
+
+Only the latest ISO build receives security updates. There are no LTS releases.
+
+| Version | Supported |
+|---------|-----------|
+| latest (rolling) | ✅ |
+
+## Reporting a Vulnerability
+
+Please **do not** report security vulnerabilities through public GitHub issues, discussions, or pull requests.
+
+Instead, report via **GitHub Private Vulnerability Reporting** for this repository. If that's unavailable, email `ash8820@proton.me`.
+
+When reporting, include:
+
+- The ISO build date or commit SHA
+- A description of the issue and why it's security-sensitive
+- Steps to reproduce or a proof of concept
+- Any relevant logs, payloads, or screenshots
+- The potential impact
+- Suggested mitigations or fixes, if known
+
+You can expect an acknowledgment within 3 business days. After assessment, I'll work on a fix and coordinate disclosure timing when appropriate.
+
+## Scope
+
+This covers the ISO build system (`buildiso`, profiles, overlays) and the live environment. For issues in custom packages (calamares, branding, keyring), report to the [antergos-packages](https://github.com/Antergos-NeXT/antergos-packages) repo. For upstream Calamares issues, report to [Calamares upstream](https://codeberg.org/calamares/calamares).