ci: improve pr/issue quality (#755)

Author: bmuddha

.coderabbit.yaml

@@ -1,144 +1,60 @@
 language: en-US
-tone_instructions: ''
-early_access: true
-enable_free_tier: true
+
 reviews:
-  profile: assertive
-  request_changes_workflow: false
-  high_level_summary: true
-  high_level_summary_instructions: ''
+  # Review style + summary placement
+  profile: chill
   high_level_summary_placeholder: "<!-- coderabbit-summary -->"
-  high_level_summary_in_walkthrough: false
-  auto_title_placeholder: ''
-  auto_title_instructions: ''
-  review_status: true
-  commit_status: true
-  fail_commit_status: false
   collapse_walkthrough: true
+
+  # Noise reduction (these default to true; we explicitly turn them off)
   changed_files_summary: false
   sequence_diagrams: false
   estimate_code_review_effort: false
-  assess_linked_issues: true
-  related_issues: true
-  related_prs: true
+  related_issues: false
+  related_prs: false
   suggested_labels: false
-  labeling_instructions: []
-  auto_apply_labels: false
-  suggested_reviewers: true
-  auto_assign_reviewers: false
+  suggested_reviewers: false
   in_progress_fortune: false
   poem: false
-  path_filters: []
-  path_instructions: []
-  abort_on_close: true
-  disable_cache: false
+  enable_prompt_for_ai_agents: false
+
+  # Auto-review behavior
   auto_review:
-    enabled: true
+    drafts: true
     auto_incremental_review: true
-    ignore_title_keywords: []
-    labels: []
-    drafts: false
     base_branches: [".*"]
-    ignore_usernames: []
+
+  # Don’t auto-generate docstrings/tests (reduce chatter)
   finishing_touches:
     docstrings:
       enabled: false
     unit_tests:
-      enabled: true
+      enabled: false
+
+  # Don’t block merges on “process checks” (keep friction low)
   pre_merge_checks:
     docstrings:
       mode: off
-      threshold: 80
     title:
       mode: off
-      requirements: ''
     description:
       mode: off
     issue_assessment:
-      mode: warning
-    custom_checks: []
+      mode: off
+
+  # Lightweight, high-signal tools for this repo
   tools:
-    # Audited languages: Rust, Shell, TypeScript/JavaScript, Protobuf, Markdown, YAML, TOML, Makefile.
-    ast-grep:
-      rule_dirs: []
-      util_dirs: []
-      essential_rules: true
-      packages: []
-    shellcheck:
-      enabled: true
     markdownlint:
       enabled: true
-    github-checks:
-      enabled: false
-      timeout_ms: 90000
-    languagetool:
-      enabled: true
-      enabled_rules: []
-      disabled_rules: []
-      enabled_categories: []
-      disabled_categories: []
-      enabled_only: false
-      level: default
-    biome:
-      enabled: true
-    yamllint:
-      enabled: true
-    gitleaks:
-      enabled: true
-    eslint:
-      enabled: true
-    buf:
-      enabled: true
-    actionlint:
-      enabled: true
     semgrep:
       enabled: true
-    clippy:
-      enabled: true
-    oxc:
-      enabled: true
-    dotenvLint:
-      enabled: true
-    checkmake:
-      enabled: true
-    osvScanner:
-      enabled: true
+
 chat:
+  # We leave emoji/ASCII art, but no auto-replies
   art: true
-  auto_reply: true
-  integrations:
-    jira:
-      usage: auto
-    linear:
-      usage: auto
+  auto_reply: false
+
 knowledge_base:
-  opt_out: false
+  # Avoid web-search commentary in reviews
   web_search:
-    enabled: true
-  code_guidelines:
-    enabled: true
-    filePatterns: []
-  learnings:
-    scope: auto
-  issues:
-    scope: auto
-  jira:
-    usage: auto
-    project_keys: []
-  linear:
-    usage: auto
-    team_keys: []
-  pull_requests:
-    scope: auto
-  mcp:
-    usage: auto
-    disabled_servers: []
-code_generation:
-  docstrings:
-    language: en-US
-    path_instructions: []
-  unit_tests:
-    path_instructions: []
-issue_enrichment:
-  planning:
-    enabled: true
+    enabled: false

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,33 @@
+name: Bug
+description: Something is broken or incorrect
+title: "bug: "
+labels: ["bug"]
+body:
+  - type: textarea
+    id: report
+    attributes:
+      label: Report
+      description: What happened + expected + minimal repro (in one block). Link logs if big.
+      placeholder: |
+        What happened:
+        Expected:
+        Repro:
+        Logs/links:
+    validations:
+      required: true
+
+  - type: input
+    id: version
+    attributes:
+      label: Commit / version
+      placeholder: "git sha / tag"
+    validations:
+      required: true
+
+  - type: input
+    id: env
+    attributes:
+      label: Environment
+      placeholder: "OS/arch + how you run it (docker/native) + anything relevant"
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Discussions
+    url: https://github.com/magicblock-labs/magicblock-validator/discussions
+    about: Q&A / ideas
+  - name: Security
+    url: https://github.com/magicblock-labs/magicblock-validator/security/policy
+    about: Report privately

.github/ISSUE_TEMPLATE/docs.yml

@@ -0,0 +1,16 @@
+name: Docs
+description: Docs missing, unclear, or wrong
+title: "docs: "
+labels: ["documentation"]
+body:
+  - type: textarea
+    id: docs
+    attributes:
+      label: Change
+      description: Where + what to change.
+      placeholder: |
+        Location (file/URL):
+        What’s wrong:
+        Suggested change:
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/feature.yml

@@ -0,0 +1,16 @@
+name: Feature
+description: New capability or improvement
+title: "feat: "
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: request
+    attributes:
+      label: Request
+      description: Problem + proposal + acceptance criteria (keep it short).
+      placeholder: |
+        Problem:
+        Proposal:
+        Acceptance criteria:
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!--
+PR title must match:
+  type(scope): summary
+Types: feat|fix|docs|chore|refactor|test|perf|ci|build
+Examples:
+  fix: avoid panic on empty slot
+  feat(rpc): add getFoo endpoint
+-->
+
+## Summary
+-
+
+## Compatibility
+- [ ] No breaking changes
+- [ ] Config change (describe):
+- [ ] Migration needed (describe):
+
+## Testing
+- [ ] tests (or explain)
+
+## Checklist
+- [ ] docs updated (if needed)
+- [ ] linked issue: #

.github/workflows/ci-fmt.yml

@@ -12,7 +12,6 @@ on:
 
 jobs:
   run_make_ci_format:
-    if: github.event.pull_request.draft == false
     runs-on: ubuntu-latest
     steps:
       - name: Checkout this magicblock-validator

CONTRIBUTING.md

@@ -0,0 +1,109 @@
+# Contributing to magicblock-validator
+
+Thanks for contributing. This repository implements a high-performance, long-running solana execution engine.  
+Correctness, determinism, and operational safety matter more than velocity.
+
+Please keep contributions **small, explicit, and reviewable**.
+
+---
+
+## Scope & Philosophy
+
+- Prefer **minimal changes** over broad refactors.
+- Avoid speculative abstractions.
+- Treat config, CLI flags, and on-disk formats as **public interfaces**.
+- Backward compatibility is the default.
+
+If you are unsure whether a change belongs here, start a **Discussion**.
+
+---
+
+## Pull Requests
+
+
+### Title format
+PR titles must follow:
+
+type(scope): short summary
+
+Where:
+- `type` ∈ `feat | fix | docs | chore | refactor | test | perf | ci | build`
+- `scope` is optional
+- use lowercase, no trailing period
+
+Examples:
+- `fix: prevent panic on empty slot`
+- `feat(rpc): add account snapshot endpoint`
+
+The PR title becomes the commit title when merged.
+
+---
+
+### Compatibility & Safety
+
+Explicitly call out any of the following in the PR description:
+- config changes
+- migrations (disk, state, network, protocol)
+- behavior changes affecting operators
+
+If none apply, mark the change as **non-breaking**.
+
+---
+
+### Testing
+
+- Changes affecting correctness, consensus, or state handling **must** be tested.
+- Small refactors may rely on existing coverage; explain why if no new tests are added.
+- Performance-sensitive changes should include rationale or benchmarks where relevant.
+
+---
+
+## Commits
+
+- Keep commits focused.
+- Avoid drive-by formatting or unrelated cleanups.
+- Squash merges are used; intermediate commit messages are not critical.
+
+---
+
+## Code Style
+
+- Follow existing patterns.
+- Prefer explicitness over cleverness.
+- Avoid macros or unsafe code unless there is a clear, documented need.
+- Performance optimizations should be obvious and justified.
+
+---
+
+## Configs & Interfaces
+
+Assume that:
+- config files
+- CLI flags
+- RPC / API surfaces
+- on-disk formats
+
+are relied upon by external operators.
+
+Changes here require:
+- documentation updates
+- compatibility notes in the PR
+- clear migration paths if breaking
+
+---
+
+## Security
+
+If you believe you’ve found a security issue, **do not open a public issue**.  
+Use the repository’s security policy instead.
+
+---
+
+## Questions & Ideas
+
+- Use **Issues** for concrete, actionable work.
+- Use **Discussions** for design questions, ideas, or uncertain proposals.
+
+---
+
+Thanks for helping keep the codebase fast, predictable, and boring in the best way.