Skip to content

add pr description template - #14

Merged
0xgleb merged 2 commits into
masterfrom
chore/pr-template
Aug 20, 2026
Merged

add pr description template#14
0xgleb merged 2 commits into
masterfrom
chore/pr-template

Conversation

@0xgleb

@0xgleb 0xgleb commented Jul 8, 2026

Copy link
Copy Markdown
Member

Motivation

PR descriptions were freeform — some empty, some run-instructions, some bot-generated noise — and math-bearing docs had no shared bar for rigor. Reviewers need the same two questions answered on every PR, and formula docs need symbols defined before use.

Solution

  • Add .github/PULL_REQUEST_TEMPLATE.md with Motivation / Solution sections and inline guidance; GitHub pre-fills it on every new PR
  • Add Documentation Standards to AGENTS.md: notation tables before first symbol use, GitHub-LaTeX conventions (no code identifiers in math mode — markdown strips \_ before MathJax parses), clickable source citations
  • All currently open PRs (feat: frontend plot #6, feat: orderbook smart contract #7, docs: margin mechanism #13) already follow the PR format

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@0xgleb, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 8 minutes

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

Wait for the limit to reset, then comment @coderabbitai review or push new commits to the PR.

An organization admin can change what happens after included review limits in Billing.

How do review limits work?

CodeRabbit enforces per-developer PR review limits within each organization.

For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 60af279e-7ac9-4efd-b25c-2ee1907b7631

📥 Commits

Reviewing files that changed from the base of the PR and between a96c3ff and 64d020e.

📒 Files selected for processing (2)
  • .github/PULL_REQUEST_TEMPLATE.md
  • AGENTS.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/pr-template

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@0xgleb 0xgleb self-assigned this Jul 8, 2026
@0xgleb
0xgleb enabled auto-merge July 19, 2026 03:36
@0xgleb
0xgleb disabled auto-merge August 19, 2026 03:30
@0xgleb
0xgleb force-pushed the chore/pr-template branch from abdfa5a to 64d020e Compare August 20, 2026 22:19
@0xgleb
0xgleb merged commit ef1d4bc into master Aug 20, 2026
1 of 2 checks passed
@0xgleb
0xgleb deleted the chore/pr-template branch August 20, 2026 22:21
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