Skip to content

docs: fix contributor validation commands - #573

Open
ThakuraAnki wants to merge 1 commit into
accordproject:mainfrom
ThakuraAnki:docs/fix-contributor-guides
Open

ThakuraAnki wants to merge 1 commit into
accordproject:mainfrom
ThakuraAnki:docs/fix-contributor-guides

Conversation

@ThakuraAnki

@ThakuraAnki ThakuraAnki commented Nov 15, 2026 •

Copy link
Copy Markdown
Contributor

Changes

  • Replaced the nonexistent npm run test command in CONTRIBUTING.md with:
    • npm --prefix website run lint
    • npm --prefix website run build
  • Removed obsolete build:api and version commands from DEVELOPERS.md.
  • Documented that Docusaurus documentation versioning is currently disabled.

Flags

  • No functional code changes.
  • Documentation-only change.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Ankit Thakur <codeankit.thakur@gmail.com>
@mira-accord-project

Copy link
Copy Markdown

Thank you for fixing these contributor commands. The change replaces the old unit-test steps in CONTRIBUTING.md and DEVELOPERS.md with the website lint and build commands, and notes that documentation versioning is disabled. Because it changes the contributor guidance, a maintainer will review it in the normal queue. We have requested a review from Matt Roberts, who chairs the Technical Steering Committee.


Posted automatically by Mira, an Accord Project agent. A maintainer will follow up; they make the decisions on this.

@mira-accord-project mira-accord-project Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this cleanup. The new commands are accurate: website/package.json defines lint and build but no test, build:api or version script, and website/docusaurus.config.js sets disableVersioning: true, so the new DEVELOPERS.md wording matches the config. The removed [developers.unit-tests] link has no other users. Nothing here blocks a merge. The two notes below are optional polish. Because this changes contributor guidance, it still needs a maintainer's approval before it can merge.

Nothing blocking; some suggestions below. Findings: 2 nit.

  • nit · conventions: The commit carries a Co-authored-by: Copilot trailer. AI_USAGE_POLICY.md asks contributors to disclose AI use in the pull request description itself. A short line in the description saying how Copilot was used and that you checked the result would meet the policy. The description also leaves out the template's Author Checklist; adding it back with the relevant boxes ticked would help reviewers.

Automated review by Mira, an Accord Project agent, at 5305270. Findings are labelled blocking, should-fix or nit; a maintainer makes the final call.

Comment thread CONTRIBUTING.md
* Ensure you provide a DCO sign-off for your commits using the `--signoff` option of git commit. For more information see [how this works][dcohow].
* If the changes affect public APIs, change or add relevant [documentation][developers.documentation].
* Run the [unit test suite][developers.unit-tests], and ensure that all tests pass.
* Run the website lint and build checks, and ensure that both commands pass.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit · docs

This line now asks for the lint and build checks, but the same section still refers to a test suite in two places: 'Create your patch commit, including appropriate test cases' and, under 'If we suggest changes', 'Re-run the test suite to ensure tests are still passing.' The repo has no test script, so a contributor following the guide will look for a suite that doesn't exist. Suggest changing the second to 'Re-run the website lint and build checks' and dropping or softening the test-cases wording. The Travis bullet is also out of date, but it was like that before this PR.

This branch has not been deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant