Skip to content

docs: clarify documentation and typo fixes are welcome - #1575

Closed
cyberspace-cs wants to merge 3 commits into
JustVugg:devfrom
cyberspace-cs:docs/improve-contributing-section
Closed

cyberspace-cs wants to merge 3 commits into
JustVugg:devfrom
cyberspace-cs:docs/improve-contributing-section

Conversation

@cyberspace-cs

Copy link
Copy Markdown

The contributing section focuses on benchmark experiments and opening an experiment issue, which may give the impression that every contribution requires an experiment issue. This adds a sentence clarifying that documentation fixes, typo corrections, and improvements to the translated READMEs are always welcome and do not require opening an experiment issue first.

What changed

  • Added a sentence after the existing contributing paragraph clarifying docs/typo fixes are welcome without an experiment issue

Verification

  • README renders correctly with the new text
  • No other content changed
  • PR targets \dev\ branch per CONTRIBUTING.md instructions

JustVugg and others added 3 commits September 15, 2026 14:39
…OTICE

The LICENSE file still carried the Apache 2.0 template placeholders
(Copyright [yyyy] [name of copyright owner]), so the notice was never
actually applied to this work. Fill it in, add the NOTICE file Apache 2.0
expects for the copyright line, and point the four READMEs at both.
license: name the copyright holder and add NOTICE
Note that docs fixes, typo corrections, and translated README
improvements do not require opening an experiment issue first.
@JustVugg

Copy link
Copy Markdown
Owner

Thank you for this. The copyright line, the NOTICE file and the license header hunks are already on dev (LICENSE, NOTICE and THIRD_PARTY_NOTICES.md all carry them today), so what this branch adds is now already in the tree and the pull request has nothing left to merge. Closing it as superseded, with credit for raising it: the notice is there because of this and the sibling PR.

@JustVugg JustVugg closed this Sep 20, 2026
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