docs: community health files, ARCHITECTURE.md, and README overhaul (#1072)
* docs: add community health files, ARCHITECTURE.md, and README overhaul Community layer: CODE_OF_CONDUCT (Contributor Covenant 2.1), issue templates (bug/feature YAML forms + contact links), PR template mirroring the Definition of Done, and a visitor-grade ARCHITECTURE.md distilled from internal docs. README: fix the clone/cd case mismatch, add CI/docker badges and site links, add a Why section (compliance-by-construction, agent-native MCP surface, self-hostable), add missing payroll and MCP feature bullets, and restructure the documentation/community sections. Hero screenshot slot left as a comment pending an approved shot. CONTRIBUTING: fix stale gnubok name, link Code of Conduct and ARCHITECTURE.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Jakob Wennberg <jakob.wennberg@gmail.com> * docs: address review feedback on community files Disable blank issues so security reports stay on the private path, require npm run build in the PR checklist to match CONTRIBUTING, and align ARCHITECTURE.md immutability wording with the actual trigger behavior (controlled posted-to-reversed transition is permitted). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Signed-off-by: Jakob Wennberg <jakob.wennberg@gmail.com> --------- Signed-off-by: Jakob Wennberg <jakob.wennberg@gmail.com> Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Fable 5
parent
90e7c7f47f
commit
920400cfb5
@@ -0,0 +1,56 @@
|
||||
name: Bug report
|
||||
description: Report something that is broken or behaving incorrectly
|
||||
labels: ["bug"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to report a bug.
|
||||
|
||||
**Do not report security vulnerabilities here.** Use our [security policy](https://github.com/erp-mafia/accounted/security/policy) instead.
|
||||
- type: textarea
|
||||
id: what-happened
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: A clear description of the bug.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
placeholder: |
|
||||
1. Go to ...
|
||||
2. Click ...
|
||||
3. See error
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: What you expected to happen instead.
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: deployment
|
||||
attributes:
|
||||
label: Deployment
|
||||
options:
|
||||
- Hosted (app.gnubok.se)
|
||||
- Self-hosted (Docker)
|
||||
- Local development
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: environment
|
||||
attributes:
|
||||
label: Browser and OS
|
||||
placeholder: "e.g. Chrome 138 on macOS 15"
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant logs or screenshots
|
||||
description: |
|
||||
Paste any error messages or attach screenshots.
|
||||
Remember to redact personal data, organization numbers, and financial details before posting.
|
||||
@@ -0,0 +1,8 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Documentation
|
||||
url: https://docs.gnubok.se
|
||||
about: User guides and API reference.
|
||||
- name: Security vulnerability
|
||||
url: https://github.com/erp-mafia/accounted/security/policy
|
||||
about: Report security issues privately, never in a public issue.
|
||||
@@ -0,0 +1,30 @@
|
||||
name: Feature request
|
||||
description: Suggest a new feature or improvement
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem does this solve?
|
||||
description: Describe the problem or friction you are running into, not just the solution.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
description: What would you like to see happen?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
description: Other approaches you have considered, or how you work around this today.
|
||||
- type: textarea
|
||||
id: context
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: |
|
||||
Anything else that helps us understand the request. For accounting features, a reference
|
||||
to the relevant Swedish rule or an example from another tool (e.g. Fortnox) is very helpful.
|
||||
@@ -0,0 +1,13 @@
|
||||
# What and why
|
||||
|
||||
<!-- What does this PR change, and why? Link related issues with "Closes #123". -->
|
||||
|
||||
## Checklist
|
||||
|
||||
- [ ] Title follows [Conventional Commits](https://www.conventionalcommits.org/) (`feat:`, `fix:`, `refactor:`, `test:`, `docs:`)
|
||||
- [ ] `npm run lint`, `npm test`, and `npm run build` pass locally
|
||||
- [ ] New or changed logic in `lib/` or `app/api/` has tests
|
||||
- [ ] New or changed UI strings exist in both `messages/sv.json` and `messages/en.json`
|
||||
- [ ] Migrations (if any) are new files in `supabase/migrations/`; no edits to already-shipped migrations
|
||||
- [ ] Core builds with zero extensions enabled (no imports from `@/extensions/` in core code)
|
||||
- [ ] Commits are signed off (`git commit -s`, see [DCO](../DCO))
|
||||
Reference in New Issue
Block a user