Skip to content

[Repo Assist] docs: add CONTRIBUTING.md guide for new contributors#116

Draft
github-actions[bot] wants to merge 1 commit into
masterfrom
repo-assist/docs-contributing-2026-03-30-bdf0d7e37a1228c0
Draft

[Repo Assist] docs: add CONTRIBUTING.md guide for new contributors#116
github-actions[bot] wants to merge 1 commit into
masterfrom
repo-assist/docs-contributing-2026-03-30-bdf0d7e37a1228c0

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

🤖 This is an automated draft PR from Repo Assist, an AI assistant.

Summary

The repository currently has no contributor guide, which makes it harder for new contributors to get started. This PR adds CONTRIBUTING.md covering:

  • Project layout — what each file/directory does
  • Local dev setupnpm install, F5 to launch Extension Development Host
  • Running testsnpm run test:unit for unit tests, VS Code runner for integration tests
  • Code style — plain JS, ESLint, 4-space indent, one concern per PR
  • PR submission steps — branching convention, linking issues with Closes #N
  • Bug reporting template — what info to include
  • Quick-reference configuration tips table — common user pain points with their solutions (reduces the number of "Does Nothing!" and "onSave Not Working" issues)
  • Maintainer notes — protected package.json and Marketplace extension ID

Why Now

Multiple issues (#8, #21, #25, #34, #43) are essentially configuration questions that could be deflected by a clear README/CONTRIBUTING guide. The new configuration tips table summarises the guidance already in the README and in Repo Assist comments, in a compact format contributors and users can quickly reference.

No Breaking Changes

Documentation-only change. No code modified.

Test Status

Unit tests: 7/7 pass — npm run test:unit
Syntax check: node --check extension.js — no errors (no code changed)

Generated by Repo Assist ·

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f

Provides project layout, local dev setup, test instructions,
code style guidance, PR submission steps, and a quick-reference
configuration tips table.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

0 participants