Skip to content

docs: add CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README, SECURITY - #15

Merged
sepehr-safari merged 1 commit into
mainfrom
docs/contributing-readme-roadmap
Jul 7, 2026
Merged

docs: add CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README, SECURITY#15
sepehr-safari merged 1 commit into
mainfrom
docs/contributing-readme-roadmap

Conversation

@sepehr-safari

Copy link
Copy Markdown
Member

Summary

Add community documentation — CONTRIBUTING, CODE_OF_CONDUCT, ROADMAP, README, and SECURITY.

What's included (Issues #9#11)

Issue #9 — CONTRIBUTING + CODE_OF_CONDUCT + ROADMAP:

  • CONTRIBUTING.md — setup, monorepo structure, development workflow, conventions (commits, branches, code style, testing), security guidelines, AI-assisted development section (tool-neutral)
  • CODE_OF_CONDUCT.md — Contributor Covenant 2.1 (enforcement via GitHub private reporting)
  • ROADMAP.md — milestone summary from M0 through v1.0.0

Issue #10 — Professional README:

  • Project description + tagline
  • Badges (CI, license, npm)
  • Architecture overview (packages + dependency graph)
  • Quickstart (from source, CLI placeholder, web app link)
  • Links (docs, GitHub, npm, roadmap, contributing)
  • Support section (USDT/BEP20 wallet)

Issue #11 — AGENTS.md + CURRENT_STATE.md:

Bonus — SECURITY.md:

  • Vulnerability reporting via GitHub private security advisories
  • Security principles for untrusted input handling

Verification

  • pnpm lint passes
  • pnpm test passes
  • pnpm format:check passes
  • No sensitive data (emails, personal info) in any committed file

Closes #9, closes #10, closes #11

@sepehr-safari sepehr-safari added type:docs Documentation improvements package:repo Repository-level changes priority:high Important for current milestone labels Jul 7, 2026
@sepehr-safari
sepehr-safari force-pushed the chore/pr-issue-templates branch from 8f0045f to 8af418e Compare July 7, 2026 20:50
Base automatically changed from chore/pr-issue-templates to main July 7, 2026 20:51
- CONTRIBUTING.md: setup, conventions, PR process, AI-assisted dev section
  (tool-neutral, no AI tool references)
- CODE_OF_CONDUCT.md: Contributor Covenant 2.1
- ROADMAP.md: milestone summary (M0 through v1.0.0)
- README.md: description, badges, architecture, quickstart, support section
  (USDT/BEP20), links
- SECURITY.md: vulnerability reporting via GitHub private advisories,
  security principles for untrusted input handling
- CURRENT_STATE.md: updated to reflect all M0 PRs

Closes #9, closes #10, closes #11
@sepehr-safari
sepehr-safari force-pushed the docs/contributing-readme-roadmap branch from 3dd04cd to 922e8e0 Compare July 7, 2026 20:51
@sepehr-safari
sepehr-safari merged commit ed6689b into main Jul 7, 2026
1 check failed
@sepehr-safari
sepehr-safari deleted the docs/contributing-readme-roadmap branch July 7, 2026 20:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

package:repo Repository-level changes priority:high Important for current milestone type:docs Documentation improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: create AGENTS.md + CURRENT_STATE.md docs: write professional README docs: add CONTRIBUTING + CODE_OF_CONDUCT + ROADMAP

1 participant