Skip to content

docs: expand contributor workflow and PR template - #65

Merged
rosspeili merged 2 commits into
ARPAHLS:mainfrom
Kangwenqiao:docs/issue-47-contributing-guide
Jul 30, 2026
Merged

docs: expand contributor workflow and PR template#65
rosspeili merged 2 commits into
ARPAHLS:mainfrom
Kangwenqiao:docs/issue-47-contributing-guide

Conversation

@Kangwenqiao

Copy link
Copy Markdown
Contributor

Description

  • restructure CONTRIBUTING.md around contribution types, fork/upstream setup, scope and changelog expectations, local verification, verified git email, and the PR workflow
  • add .github/PULL_REQUEST_TEMPLATE.md with Rooms-specific change types and review checks
  • refresh the README and docs hub contribution links, including the planned agent workflow tracked in Add agent-native contribution workflow doc for Rooms #48

The guide uses Rooms paths, labels, and CI commands without carrying over Skillware registry or manifest-specific instructions.

Validation

  • uv run --with pytest --with-requirements requirements.txt python -m pytest tests/test_docs_hub.py -q (19 passed)
  • uv run --with pytest --with-requirements requirements.txt python -m pytest -q (77 passed)
  • uv run --with flake8 --with-requirements requirements.txt python -m flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics (0 errors)
  • git diff --check

CHANGELOG.md is unchanged because this PR documents contributor workflow without changing product behavior.

Closes #47

@rosspeili

Copy link
Copy Markdown
Contributor

Thanks for this as well @Kangwenqiao.

Minor gaps / not blocking, but again, would incude in this PR to avoid follow ups

  • The old bug/feature reporting pointers to issue templates were removed, worth a short line under “Ways to contribute” (e.g. use GitHub Bug Report / Feature Request templates).
  • Design principles (local-first, zero-leakage, aesthetic CLI) were dropped, a brief bullet block would preserve repo culture without bloating the doc.
  • Centered logo/ARPA footer in CONTRIBUTING.md was removed, fine functionally, optional polish if we want visual consistency with README.
  • Install example uses .venv while README uses venv, minor inconsistency across docs.
  • Doc contributors could mention tests/test_docs_hub.py as a quick link check (optional).
  • No CHANGELOG update, correct for this change type per the policy you documented.

Ripple effects

Thanks again, this should cut down repeated review asks on tests, changelog, and git email. <3

@Kangwenqiao

Copy link
Copy Markdown
Contributor Author

Thanks for the detailed feedback. I addressed all of the suggested follow-ups in 093c383:

  • restored Bug Report and Feature Request template links
  • added concise local-first, zero-leakage, and aesthetic CLI principles
  • restored the centered Rooms header and ARPA footer
  • aligned the virtual environment name with README (venv)
  • added tests/test_docs_hub.py as the quick documentation link check

Validation: documentation tests pass (19), and the full suite passes (77).

@rosspeili
rosspeili merged commit 4064e9f into ARPAHLS:main Jul 30, 2026
1 check passed
@rosspeili

Copy link
Copy Markdown
Contributor

Thanks for this too @Kangwenqiao, this is beautiful and clean.

LGTM and will merge after CI. Appreciate the quick turnaround. ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure CONTRIBUTING.md and add pull request template (Skillware-style)

2 participants