Skip to content

docs: add contributing section#4

Merged
rdtect merged 1 commit intomainfrom
docs/improve-readme
Mar 24, 2026
Merged

docs: add contributing section#4
rdtect merged 1 commit intomainfrom
docs/improve-readme

Conversation

@rdtect
Copy link
Copy Markdown
Owner

@rdtect rdtect commented Mar 24, 2026

Adds a contributing section pointing to plugin architecture docs.

Copilot AI review requested due to automatic review settings March 24, 2026 13:04
@rdtect rdtect merged commit 0af3664 into main Mar 24, 2026
2 checks passed
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a Contributing section to the repository README, intended to direct contributors to documentation about the plugin architecture.

Changes:

  • Introduces a new ## Contributing section in README.md
  • Adds a link intended to point readers to plugin architecture documentation

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


## Contributing

See [Plugin Architecture](docs/) for how to build plugins.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

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

The link target docs/ doesn’t contain plugin architecture documentation in this repo (it only has docs/plans/*). This makes the new contributing link effectively broken/misleading. Consider linking to the actual plugin system documentation (e.g., ARCHITECTURE.md#5-plugin-system) or adding the referenced doc under docs/ and pointing to that file.

Suggested change
See [Plugin Architecture](docs/) for how to build plugins.
See [Plugin Architecture](ARCHITECTURE.md#5-plugin-system) for how to build plugins.

Copilot uses AI. Check for mistakes.
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.

2 participants