Docs/contribution guidelines by 0xaskr · Pull Request #162 · primatrix/pallas-kernel

0xaskr · 2026-04-07T02:16:29Z

Summary by CodeRabbit

Documentation
- Added GitHub issue templates for bug reports and feature requests
- Added pull request template with standardized sections
- Added comprehensive contributing guidelines
Chores
- Updated README with link to contribution documentation

Closes #136 (partial) - English version of contribution guide covering setup, workflow, commit conventions, review process, and coding standards. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

… spec, profiling guide, and hardware access - Add detailed review process steps - Add Kernel Design requirements (algorithm, data flow, roofline/80% target, trace viewer, precision) - Update branching strategy from fork-based to in-repo dev branches with CI check - Clarify tiered review policy (1 approve general, all-core-devs for cpu-ref) - Add profiling guide (xprof/TensorBoard Profiler setup and trace analysis) - Add hardware access section (SkyPilot scripts) - Include spec and plan documents Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

coderabbitai · 2026-04-07T02:16:45Z

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4423906a-9a98-4143-a56c-929f401fbd64

📥 Commits

Reviewing files that changed from the base of the PR and between 90ad718 and b2b07ef.

📒 Files selected for processing (5)

.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/PULL_REQUEST_TEMPLATE.md
CONTRIBUTING.md
README.md

📝 Walkthrough

Walkthrough

The pull request adds standardized GitHub templates for bug reports and feature requests, a pull request template with development checklists, and comprehensive contribution guidelines (CONTRIBUTING.md) covering repository setup, development workflow, code standards, kernel design requirements, and testing procedures. A "Contributing" section is also added to the README.

Changes

Cohort / File(s)	Summary
GitHub Templates `.github/ISSUE_TEMPLATE/bug_report.md`, `.github/ISSUE_TEMPLATE/feature_request.md`, `.github/PULL_REQUEST_TEMPLATE.md`	New standardized templates for bug reports, feature requests, and pull requests with structured sections for metadata, checklists, and required information.
Documentation `CONTRIBUTING.md`, `README.md`	New comprehensive contribution guidelines covering setup, development workflow, code standards, kernel design, testing, and profiling; README updated with Contributing section link.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hop along, dear contributors,
With templates to light the way,
Bug reports and features in order,
Guidelines to guide your day!
Clear standards, from kernel to test,
Our burrow grows stronger, blessed! 🌿

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch docs/contribution-guidelines

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 and usage tips.}

gemini-code-assist

Code Review

This pull request establishes the project's contribution framework by adding issue and pull request templates, a detailed contribution guide, and updating the README. The review feedback identifies several necessary corrections: updating the source directory path from src/ to tops/ in linting commands and the PR checklist, ensuring consistency in the design document directory paths, and removing a link to a non-existent Chinese version of the contributing guide.

gemini-code-assist · 2026-04-07T02:18:12Z

README.md


+## Contributing
+
+We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) ([中文版](CONTRIBUTING.zh.md)) to get started.


The link to CONTRIBUTING.zh.md appears to be broken as the file is not included in this pull request. If the Chinese version of the contributing guide is not yet available, please remove this link to avoid 404 errors.

Suggested change

We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) ([中文版](CONTRIBUTING.zh.md)) to get started.

We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) to get started.

gemini-code-assist · 2026-04-07T02:18:12Z

CONTRIBUTING.md

+
+```bash
+# Lint
+uv run ruff check src/ tests/


The path src/ seems incorrect. Based on ARCHITECTURE.md and the repository structure, the source code is located in the tops/ directory at the root. Running ruff on src/ will likely fail or find no files.

Suggested change

uv run ruff check src/ tests/

uv run ruff check tops/ tests/

gemini-code-assist · 2026-04-07T02:18:12Z

CONTRIBUTING.md

+uv run ruff check src/ tests/
+
+# Format
+uv run ruff format src/ tests/


The path src/ should be updated to tops/ to match the project's directory structure as defined in the architecture documentation.

Suggested change

uv run ruff format src/ tests/

uv run ruff format tops/ tests/

gemini-code-assist · 2026-04-07T02:18:12Z

CONTRIBUTING.md

+
+## Kernel Design Requirements
+
+Every new or refactored Kernel **must** have a design document in `docs/design/` covering the following:


There is a discrepancy in the design document path. ARCHITECTURE.md (the System of Record) specifies docs/design-docs/ops/ (line 42), while this file uses docs/design/. Please align them for consistency.

Suggested change

Every new or refactored Kernel **must** have a design document in `docs/design/` covering the following:

Every new or refactored Kernel **must** have a design document in docs/design-docs/ops/ covering the following:

gemini-code-assist · 2026-04-07T02:18:12Z

CONTRIBUTING.md

+
+## Adding New Kernels
+
+1. Write a design document in `docs/design/` first.


The path for design documents should be updated to docs/design-docs/ops/ to maintain consistency with the architecture documentation and previous sections of this guide.

Suggested change

1. Write a design document in `docs/design/` first.

1. Write a design document in docs/design-docs/ops/ first.

gemini-code-assist · 2026-04-07T02:18:12Z

.github/PULL_REQUEST_TEMPLATE.md

+
+## Checklist
+
+- [ ] Code passes `uv run ruff check src/ tests/` and `uv run ruff format src/ tests/`


The ruff commands in the checklist should be updated to use the tops/ directory instead of src/, as the latter does not exist in the project root according to the architecture guide.

0xaskr and others added 7 commits April 3, 2026 14:09

docs: add CONTRIBUTING.md with contribution guidelines

6445a4e

Closes #136 (partial) - English version of contribution guide covering setup, workflow, commit conventions, review process, and coding standards. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs: add CONTRIBUTING.zh.md Chinese contribution guide

6f03231

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs: add GitHub issue templates for bug reports and feature requests

686d1b6

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs: add pull request template with review checklist

0de132d

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs: add contributing section to README.md

65bd0e5

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs: remove CONTRIBUTING.zh.md, docs/superpowers/*

aa25df1

Merge branch 'main' into docs/contribution-guidelines

b2b07ef

0xaskr added this pull request to the merge queue Apr 7, 2026

Merged via the queue into main with commit efed987 Apr 7, 2026
1 check failed

0xaskr deleted the docs/contribution-guidelines branch April 7, 2026 02:17

gemini-code-assist bot reviewed Apr 7, 2026

View reviewed changes

0xaskr mentioned this pull request Apr 7, 2026

建立 issue 模板 #149

Closed

This was referenced Apr 7, 2026

docs: unify design doc path and fix broken references #169

Merged

docs: add Issue Management guidelines to CONTRIBUTING.md #170

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs/contribution guidelines#162

Docs/contribution guidelines#162
0xaskr merged 8 commits intomainfrom
docs/contribution-guidelines

0xaskr commented Apr 7, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Apr 7, 2026 •

edited

Loading

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Apr 7, 2026

Uh oh!

gemini-code-assist bot Apr 7, 2026

Uh oh!

gemini-code-assist bot Apr 7, 2026

Uh oh!

gemini-code-assist bot Apr 7, 2026

Uh oh!

gemini-code-assist bot Apr 7, 2026

Uh oh!

gemini-code-assist bot Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant


		## Contributing

		We welcome contributions! Please read our [Contributing Guide](CONTRIBUTING.md) ([中文版](CONTRIBUTING.zh.md)) to get started.

	uv run ruff format src/ tests/
	uv run ruff format tops/ tests/


		## Kernel Design Requirements

		Every new or refactored Kernel must have a design document in `docs/design/` covering the following:


		## Adding New Kernels

		1. Write a design document in `docs/design/` first.

	1. Write a design document in `docs/design/` first.
	1. Write a design document in docs/design-docs/ops/ first.


		## Checklist

		- [ ] Code passes `uv run ruff check src/ tests/` and `uv run ruff format src/ tests/`

Conversation

0xaskr commented Apr 7, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Apr 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

0xaskr commented Apr 7, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 7, 2026 •

edited

Loading