Skip to content

Establish a contributor-ready open-source project baseline - #23

Merged
Aaqibhafeezkhan merged 1 commit into
mainfrom
chore/oss-contributor-baseline
Oct 31, 2026
Merged

Aaqibhafeezkhan merged 1 commit into
mainfrom
chore/oss-contributor-baseline

Conversation

@Aaqibhafeezkhan

Copy link
Copy Markdown
Owner

Goal

Make NoCodeComments welcoming and practical for outside contributors without changing the parser's behavior or expanding the current product scope.

Scope

  • Add an MIT license for repository-owned code.
  • Add clear contribution, code-of-conduct and security reporting guidance.
  • Add concise bug-report, feature-request and pull-request templates.
  • Add a lightweight GitHub Actions workflow that runs the existing Node.js test suite on pull requests and pushes to the default branch.
  • Improve the README with a concise project overview, current browser-first capabilities, setup, testing, limitations, contribution links and roadmap/phase references.
  • Keep the existing Phase 0/Phase 1 parser baseline and Epic Epic: NoCodeComments reliability, parser safety and CLI readiness #17 roadmap intact.

Acceptance criteria

  • A new contributor can understand the project, run it locally and run its tests from the README.
  • License scope is explicit and does not claim rights over third-party material.
  • Security reports are directed to a private reporting channel rather than public issues.
  • Templates collect actionable reproduction steps or acceptance criteria.
  • CI uses the supported Node.js version and runs the existing test command; no deployment workflow or unnecessary build system is introduced.
  • One focused PR, one commit, a one-line self-review and merge.

Copy link
Copy Markdown
Owner Author

Self-review: The README matches the existing browser-first implementation and its lexical-scanner limitations; contributor, conduct and private security guidance are in place; issue/PR templates collect actionable details; and CI runs the existing Node.js 20 test suite without adding dependencies or a build step.

@Aaqibhafeezkhan
Aaqibhafeezkhan merged commit 74cfc3b into main Oct 31, 2026
1 check passed
@Aaqibhafeezkhan
Aaqibhafeezkhan deleted the chore/oss-contributor-baseline branch November 6, 2026 15:33
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