diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d9fcb27..98e82ee 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -55,15 +55,9 @@ CI is the source of truth for the full pre-merge matrix. It runs lint, unit test 2. Make your changes 3. Add or update tests and user-facing documentation when behavior changes 4. Run the checks relevant to your change and note any skipped checks with a reason -5. Open a PR against `main` +5. Open a PR against `main`, titled as a conventional commit such as `fix(core): reject empty tool names` -### PR Checklist - -- [ ] Tests cover changed behavior, or the PR explains why tests are not needed -- [ ] User-facing documentation and examples are updated, or marked not applicable -- [ ] Compatibility, breaking changes, and migration requirements are documented, or marked not applicable -- [ ] Dependency changes are justified and follow the package-specific rules below -- [ ] The PR links a relevant issue when one exists +Opening a PR prefills the [pull request template](pull_request_template.md), which carries the review checklist. Fill in the sections it asks for instead of deleting them, and write "None" or "Not applicable" where a category does not apply. ## Code Style diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 55f153d..a0762bb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -18,37 +18,10 @@ Steps to reproduce the behavior: 2. Call `runTeam(...)` with '...' 3. See error -## Current behavior - -Describe the observed behavior or the deterministic failing-test procedure. - ## Expected behavior A clear description of what you expected to happen. -## Acceptance criteria - -- State each objectively verifiable result as a separate bullet. -- Include the focused test or command outcome when one is known. - -## Target paths - -- `path/to/exact-file.test.ts` - -Use normalized repository-relative files or directories. Do not use globs. - -## Out of scope - -- List code, behavior, public APIs, dependencies, or workspaces that must not change. - -## Open decisions - -None. - -## Blockers - -None. - ## Error output ``` diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 58c2b1e..ad70959 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -21,40 +21,6 @@ assignees: '' A clear description of the problem or limitation you're experiencing. -## Current behavior - -Describe what the repository does today and why that is insufficient. - -## Expected behavior - -Describe the bounded behavior that should exist after this issue is complete. - -## Acceptance criteria - -- State each objectively verifiable result as a separate bullet. -- Include the focused test or command outcome when one is known. - -## Target paths - -- `path/to/exact-file.ts` - -Use normalized repository-relative files or directories. Do not use globs. - -## Out of scope - -- List code, behavior, public APIs, dependencies, or workspaces that must not change. - -## Open decisions - -None. - - - -## Blockers - -None. - ## Proposed Solution Describe what you'd like to happen. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ed73241..1ebc0d7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,12 @@ + + ## Summary @@ -24,6 +33,10 @@ that was not run. Common checks include: - npm test - npm run build - npm run test:scaffold (for create-oma-app scaffolding or template changes) + +Scope a check to one workspace when that is faster, for example +`npm test -w @open-multi-agent/core`. The full list of commands is in +https://github.com/open-multi-agent/open-multi-agent/blob/main/.github/CONTRIBUTING.md#running-tests --> ## Checklist @@ -31,4 +44,5 @@ that was not run. Common checks include: - [ ] Tests were added or updated for changed behavior, or a rationale is provided - [ ] User-facing documentation and examples were updated, or this is not applicable - [ ] Compatibility, breaking changes, and migration requirements are documented, or this is not applicable -- [ ] Dependency changes are justified and preserve the package ownership boundaries documented in CONTRIBUTING +- [ ] Dependency changes are justified and preserve the [package ownership boundaries](https://github.com/open-multi-agent/open-multi-agent/blob/main/.github/CONTRIBUTING.md#code-style) +- [ ] A relevant issue is linked when one exists