Skip to content

docs: expand CONTRIBUTING guide and add PR template - #106

Open
olalois wants to merge 6 commits into
wraith-protocol:developfrom
olalois:docs/contributing-guide-and-pr-template
Open

docs: expand CONTRIBUTING guide and add PR template#106
olalois wants to merge 6 commits into
wraith-protocol:developfrom
olalois:docs/contributing-guide-and-pr-template

Conversation

@olalois

@olalois olalois commented Jul 27, 2026

Copy link
Copy Markdown

Summary

Expands the bare CONTRIBUTING.md and adds .github/PULL_REQUEST_TEMPLATE.md to address the recurring new-contributor mistakes identified in the issue (wrong base branch, wrong PR target, missing conventional-commit prefix).

Closes #91

Type of change

  • docs — changes to meta-docs (CONTRIBUTING.md, README.md, templates)

Branch checklist

  • I branched from develop, not main
  • This PR targets develop, not main
  • My PR title follows conventional commits format

Content checklist

  • No marketing copy — descriptions explain what, not how great
  • N/A — no MDX pages modified

Snippet checklist

  • N/A — no .mdx files with code fences were added or modified

What's included

CONTRIBUTING.md

  • Branch model section (develop = trunk, main = release) with visual diagram and prominent warning callout
  • Getting started: prerequisites, fork/clone, pnpm install, upstream sync, branch naming convention table
  • Making changes: file structure, writing style rules, MDX conventions
  • Commit messages: conventional commits reference table, examples, and rules
  • Opening a pull request: step-by-step guide + common mistakes table
  • Code and snippet standards: how the checker works, no-check usage policy, Stellar testnet job behaviour
  • CI checks table (blocking vs non-blocking)
  • Review process: squash-merge policy, develop → main release cadence

.github/PULL_REQUEST_TEMPLATE.md

  • Summary field with Closes # pre-filled
  • Type of change checkboxes (6 conventional commit types)
  • Branch checklist targeting the three recurring mistakes from the issue
  • Content checklist (TypeScript / Chain enum / no marketing copy)
  • Snippet checklist with pnpm run check:snippets reminder and no-check justification prompt

@olalois
docs: expand CONTRIBUTING guide and add PR template
7147a94 
- Add comprehensive CONTRIBUTING.md with branch model, conventional
  commits reference, setup instructions, snippet standards, and
  CI check table
- Add .github/PULL_REQUEST_TEMPLATE.md with branch checklist,
  conventional-commit type selector, content checklist, and
  snippet-check reminder

Closes wraith-protocol#91
@drips-wave

drips-wave Bot commented Jul 27, 2026

Copy link
Copy Markdown

@olalois Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

olalois added 2 commits July 28, 2026 13:26
@olalois
docs(contributing): add contributing.mdx to docs site + wire navigation
be57423 
- Add contributing.mdx (Mintlify page) surfacing branch model, conventional
  commit format, and snippet-check guidance
- Register 'contributing' in docs.json Overview navigation group
- Update docs/CONTRIBUTING.md to redirect to root CONTRIBUTING.md
@olalois
chore(ci): enforce branch model and conventional commit title in CI
c5754b2 
- Add guard-main.yml: blocks any PR targeting main with a clear
  error message directing contributors to retarget to develop
- Add pr-title-lint.yml: validates PR title matches conventional
  commit pattern (type(scope): description) on open/edit/sync
- Restore reference/stellar-event-schemas.mdx: file was deleted in
  db12d1b alongside unrelated reference/ material; docs.json still
  references it, causing a dead nav link — restored from git history
- Add packageManager field to package.json (pnpm@10.0.0) to match
  the pinned version in CI and prevent version drift for local devs
- Update CONTRIBUTING.md CI table to document all four checks
@olalois

olalois commented Jul 29, 2026

Copy link
Copy Markdown
Author

Hi, my PR is currently waiting for workflow approvals.
Could a maintainer please approve the workflows so checks can run?

@truthixify

truthixify commented Aug 6, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

CI fails because multiple pnpm versions are configured. Please keep one pnpm version/source, then rerun the snippet checks.

@truthixify

truthixify commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Thanks for the update. Not mergeable yet: docs.json is invalid near the API Reference pages list. Please add the missing comma, remove the duplicate api-reference/types, and keep this PR scoped to the contributing guide and PR template. The migration and codemod pages belong in #120.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Contributing guide expansion + PR template

2 participants

@olalois @truthixify