lizhimins opened a new pull request, #4381:
URL: https://github.com/apache/rocketmq-dashboard/pull/4381
### Which Issue(s) This PR Fixes
- Refs #4379
### Brief Description
Contributor-facing documentation for the repository now that `master` is the
RocketMQ Studio
trunk:
- **`CONTRIBUTING.md`** — the contribution workflow (search first, open an
issue, discuss
non-trivial designs there before implementing, branch from `master`,
squash merge,
Conventional Commits), the development environment (JDK 21, Maven 3.9+,
Node >= 20.19,
Docker), how to run the stack and the tests — including the MySQL 8
instance with
`server/src/main/resources/db/schema.sql` that the `@SpringBootTest`
integration tests need —
the quality bar for a pull request, the code standards that review and
ArchUnit already
enforce, the 7-day stale bot, the ASF ICLA/CCLA note and where to talk.
- **`.github/ISSUE_TEMPLATE/`** — `bug_report.yml`, `feature_request.yml`,
`enhancement_request.yml`, `doc.yml` and `config.yml`
(`blank_issues_enabled: false`), modelled
on the templates in `apache/rocketmq` and adapted to Studio: they ask for
the Studio version
and deployment mode, the connected cluster version and access mode (Proxy
gRPC / Proxy
remoting / Direct), and remind reporters not to paste credentials. Issue
templates are only
read from the default branch, so they take effect once this is merged.
- **`.github/PULL_REQUEST_TEMPLATE.md`** — base-branch reminder, `Fixes #`,
brief description,
"how did you test this change" and a checklist.
- **`README.md` / `README_zh.md`** — one line each, as the first bullet of
*Development
Guidelines* / *开发规范*: `master` is the trunk, `master_archive` is the
archived legacy
dashboard history.
### How Did You Test This Change?
Documentation and issue-form metadata only; no application code, build or
runtime behaviour is
affected.
- All five issue-form files parse with `yaml.safe_load`; field counts per
form:
bug report 12, feature request 7, enhancement request 8, doc report 6.
- Every `labels:` value used by the forms already exists in this repository
— verified against
`gh api repos/apache/rocketmq-dashboard/labels` (`bug`, `enhancement`,
`documentation`). Issue
forms reject labels that do not exist, so the `type/new feature` and
`module/doc` labels used
by `apache/rocketmq` are deliberately not reused here.
- `config.yml` points questions at the RocketMQ mailing list and at
`apache/rocketmq`
Discussions rather than at this repository, because Discussions are
disabled here
(`has_discussions: false`).
- Every factual statement was taken from the repository rather than assumed:
`java.version` from
`server/pom.xml`, `engines.node` and the `test` script from
`web/package.json`, the jobs from
`.github/workflows/ci.yml`, the MySQL service and its schema bootstrap from
`deploy/docker-compose.yml` (`3306`, `MYSQL_DATABASE=rocketmq`, `init.sql`
sources
`schema.sql`), and the stale-bot settings from
`.github/workflows/stale.yml`.
- Both READMEs render as valid Markdown and stay in sync with each other.
--
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]
