Skip to content

docs: add Contributing section to README - #14

Open
cyberspace-cs wants to merge 1 commit into
cloudflare:mainfrom
cyberspace-cs:docs/add-contributing-section
Open

cyberspace-cs wants to merge 1 commit into
cloudflare:mainfrom
cyberspace-cs:docs/add-contributing-section

Conversation

@cyberspace-cs

Copy link
Copy Markdown

The README describes what the skill does, its files, installation, usage, requirements, design principles, and contact info, but has no section explaining how to contribute. This adds a concise Contributing section before Contact, covering bug reports, documentation fixes, improvements, and the expectation to discuss significant changes via issues first.

What changed

  • Added a Contributing section with guidance on bug reports, docs fixes, and improvements
  • Notes that significant changes should be discussed in an issue before a PR

Verification

  • README renders correctly with the new section
  • Section placement is logical (before Contact, after Requirements/Design)

Describe how to report bugs, submit documentation fixes, and propose
improvements, with a note to discuss significant changes via issues.
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.

1 participant