mirror of
https://github.com/bmad-code-org/BMAD-METHOD.git
synced 2026-09-19 08:11:52 +08:00
Alex Verkhovsky
ad86519c6b
* build: replace the npm lint stack with pre-commit markdownlint-cli2, prettier and eslint for YAML/JSON, husky and lint-staged are gone. pre-commit runs ruff, rumdl (the same five markdown rules), yamllint, yamlfix, the JSON checks, both validators and pytest, at commit time and over the whole tree from tools/quality.py, which is now what `npm run quality` calls. ESLint and prettier stay only for the docs-site scripts and tests. quality.yaml collapses to a Python job and a docs-site job. yamlfix keeps one blank line and no document-start marker: its defaults strip blank lines inside block scalars and add `---`, which the sprint status scripts do not write back. The JSON hook keeps key order and non-ASCII text. * style: apply yamlfix and JSON formatting to the tree Mechanical output of the new hooks; every file parses to the same data. * docs: state what the commit hook covers
58 lines
1.5 KiB
YAML
58 lines
1.5 KiB
YAML
name: Documentation
|
|
description: Report issues or suggest improvements to documentation
|
|
title: '[DOCS] '
|
|
labels: documentation
|
|
assignees: []
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Help us improve the BMad Method documentation!
|
|
|
|
- type: dropdown
|
|
id: doc-type
|
|
attributes:
|
|
label: What type of documentation issue is this?
|
|
options:
|
|
- Error or inaccuracy
|
|
- Missing information
|
|
- Unclear or confusing
|
|
- Outdated content
|
|
- Request for new documentation
|
|
- Typo or grammar
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: location
|
|
attributes:
|
|
label: Documentation location
|
|
description: Where is the documentation that needs improvement?
|
|
placeholder: e.g., https://docs.bmad-method.org/tutorials/getting-started/ or
|
|
"In the README"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: issue
|
|
attributes:
|
|
label: What's the issue?
|
|
description: Describe the documentation issue in detail
|
|
placeholder: e.g., Step 3 says to run command X but it should be command Y
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: suggestion
|
|
attributes:
|
|
label: Suggested improvement
|
|
description: How would you like to see this improved?
|
|
placeholder: e.g., Change the command to X and add an example
|
|
|
|
- type: input
|
|
id: version
|
|
attributes:
|
|
label: BMad Version (if applicable)
|
|
placeholder: e.g., 6.0.0-Beta.4
|