chore: professionalize project for community contributions

- Add CONTRIBUTING.md with guidelines for PRs and issues
- Add CODE_OF_CONDUCT.md (Contributor Covenant v2.1)
- Add SECURITY.md with vulnerability reporting policy
- Add CHANGELOG.md for version tracking
- Add issue templates (bug, feature, compatibility)
- Add Actions CI (ShellCheck, syntax check, markdown lint)
- Add .gitignore for backup dirs and OS artifacts
- Update README with badges and new commands
- Bump version to 1.1.0
- Update comparison table with new features
This commit is contained in:
2026-06-20 11:59:22 -03:00
parent 58b96c4e11
commit ca7b8b0079
11 changed files with 382 additions and 3 deletions
+30
View File
@@ -0,0 +1,30 @@
---
name: Bug report
about: Something is not working as expected
title: ''
labels: bug
assignees: ''
---
**Describe the bug**
A clear description of what is not working.
**To reproduce**
1. Run `./unleash <command>` from Recovery / booted system
2. See error: ...
**Expected behavior**
What should have happened instead.
**Environment**
- macOS version: (e.g. Sequoia 15.5, Tahoe 26.3)
- Hardware: (Intel / Apple Silicon M1/M2/M3/M4)
- Recovery mode: (Yes / No)
- FileVault: (Enabled / Disabled)
**Screenshots or logs**
If applicable, add output from `unleash status` or terminal logs.
**Additional context**
Anything else relevant.
@@ -0,0 +1,32 @@
---
name: Compatibility report
about: Report success or failure on a specific macOS version or hardware
title: ''
labels: compatibility
assignees: ''
---
**macOS version tested**
e.g. macOS Tahoe 26.5.1
**Hardware**
e.g. MacBook Pro M4 Pro (2025)
**Command tested**
[ ] bypass
[ ] suppress
[ ] heal
[ ] persist
[ ] firewall
[ ] harden
[ ] audit
[ ] whitelist
**Result**
[ ] Works perfectly
[ ] Works with issues (describe below)
[ ] Does not work
**Details**
Any errors, unexpected behavior, or observations.
+20
View File
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for unleash
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem?**
Describe what doesn't work or could be improved.
**Describe the solution you'd like**
What should the new command or behavior look like?
**Describe alternatives you've considered**
Other approaches or workarounds.
**Additional context**
Add any references (other tools, links, screenshots).
+54
View File
@@ -0,0 +1,54 @@
name: CI
on:
push:
branches: [main]
pull_request:
branches: [main]
jobs:
shellcheck:
name: ShellCheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Run ShellCheck
uses: ludeeus/action-shellcheck@master
with:
severity: warning
additional_files: >
unleash
lib/colors.sh
lib/detect.sh
lib/validate.sh
lib/dscl.sh
lib/suppress.sh
lib/backup.sh
lib/status.sh
lib/heal.sh
lib/firewall.sh
lib/harden.sh
lib/whitelist.sh
syntax:
name: Bash Syntax Check
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check syntax
run: |
for f in unleash lib/*.sh examples/*.sh; do
[ -f "$f" ] || continue
echo "Checking: $f"
bash -n "$f" || exit 1
done
echo "All files pass syntax check"
markdown:
name: Markdown Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: '*.md'