chore: add CI, issue/PR templates, and CONTRIBUTING.md - #108
Merged
Conversation
Set up the community-facing infrastructure a maintained OSS project needs: - GitHub Actions CI: py_compile on tools/, unittest discover (no-op until tests/ exists), and a non-blocking ruff lint job. Runs on push to main and on pull_request, matrix over Python 3.9 and 3.11. - Pull request template with bilingual EN/CN prompts, a testing checklist, and a security reminder about secrets. - Issue templates for bug, feature, and question, plus a config.yml that disables blank issues and links to Discord and the skill gallery. - CONTRIBUTING.md covering branch naming, commit style (Conventional Commits), dev setup, test expectations, security rules (no secrets, 0600 perms on credential files), and docs/i18n expectations. This is prep work so future PRs (e.g. #106 Confluence collector) can be reviewed against a consistent bar.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Set up community-facing infrastructure so future PRs (e.g. #106 Confluence collector) can be reviewed against a consistent bar.
Changes
.github/workflows/ci.yml— GitHub Actions CIpython -m compileall tools/— catches syntax errors in every toolpython -m unittest discover -s tests -p 'test_*.py'— no-op until a `tests/` directory exists, then picks up everything automatically|| true) — surfaces style/quality hints without failing PRs while we adoptmainand on PRs.github/PULL_REQUEST_TEMPLATE.md— bilingual EN/CN template with a testing checklist, secrets reminder, and doc-update prompt.github/ISSUE_TEMPLATE/— bug / feature / question templates +config.ymlthat disables blank issues and links to Discord and the skill galleryCONTRIBUTING.md— branch naming, Conventional Commits, dev setup, test expectations, security rules (no secrets,0600perms on credential files), i18n expectationsTesting
python -m compileall tools/— passesNotes for reviewer
tests/directory doesn't exist yet onmain. The CI handles this gracefully (prints a message, doesn't fail). Once PR feat: add reviewer generators and English skill assets #103 or any future PR adds tests, discovery activates automatically.|| trueto hard-fail once the codebase is clean.