justinmclean opened a new issue, #358:
URL: https://github.com/apache/airflow-steward/issues/358
## Summary
Add a short recommended setup order to `projects/_template/README.md` so new
adopters know which template files to fill in first.
## Background
The project template already lists what each file is for and has a checklist
after copying. A new adopter still has to infer the best order to work through
the files. Adding a small "Recommended setup order" section would make the
scaffold easier to follow without changing any framework behavior.
## Where to look
- `projects/_template/README.md` — add the new setup-order guidance near the
existing "What each file is for" or "Checklist after copying" sections.
- Related: `projects/_template/project.md` — this should remain the first
file adopters fill in.
- Related: `projects/_template/canned-responses.md`,
`projects/_template/release-trains.md`, `projects/_template/security-model.md`,
`projects/_template/milestones.md`, `projects/_template/scope-labels.md`, and
`projects/_template/fix-workflow.md`.
## Acceptance criteria
- [ ] `projects/_template/README.md` includes a short "Recommended setup
order" section.
- [ ] The section uses this order, or a similar order that explains why it
differs:
1. `project.md`
2. `security-model.md`
3. `release-trains.md`
4. `scope-labels.md` and `milestones.md`
5. `canned-responses.md`
6. `fix-workflow.md`
7. Optional skill-family files, such as `issue-tracker-config.md`,
`runtime-invocation.md`, `pr-management-config.md`, and
`pr-management-code-review-criteria.md`.
- [ ] The section tells adopters to run `grep -rn TODO projects/<name>`
after copying the template.
- [ ] The change is documentation-only.
## Estimated effort
~15-30 minutes for someone new to the repository.
## Getting started
Before starting work, please leave a short comment on this issue so other
contributors know you are looking at it.
- [Contributing
guide](https://github.com/apache/airflow-steward/blob/main/CONTRIBUTING.md)
- [Local
setup](https://github.com/apache/airflow-steward/blob/main/CONTRIBUTING.md#getting-set-up)
- [How to open a pull
request](https://github.com/apache/airflow-steward/blob/main/CONTRIBUTING.md#opening-a-pull-request)
---
_This issue was drafted with the help of an AI-assisted tool and reviewed by
an maintainer before posting. If anything here is unclear or looks wrong, say
so on the issue: a real person is reading._
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
