Skip to content

chore: add standard contribution requirements#359

Merged
wooway777 merged 4 commits intomainfrom
chore/standard-contribution-requirements
May 9, 2026
Merged

chore: add standard contribution requirements#359
wooway777 merged 4 commits intomainfrom
chore/standard-contribution-requirements

Conversation

@wooway777
Copy link
Copy Markdown
Collaborator

@wooway777 wooway777 commented May 8, 2026

Summary

  • 增加格式化工具
  • 增加模型适配说明
  • 增加贡献指南
  • 增加pr模板

Motivation

Closes #358

Type of Change

  • feat — new feature / new operator / new platform
  • fix — bug fix
  • perf — performance improvement (no behavioral change)
  • refactor — code restructuring without behavior change
  • test — adding or fixing tests only
  • docs — documentation only
  • build / ci — build system or CI configuration
  • chore — tooling, formatting, or other non-code changes
  • Breaking change

Test Results on Supported Platforms

No code changes

Benchmark / Performance Impact

No performance changes

Notes for Reviewers

纯文本修改

Checklist

Every contributor must verify every item below before requesting
review. Tick each box only after the check has actually been performed —
do not tick speculatively. If an item truly does not apply, replace the
checkbox with N/A and briefly explain why in an inline comment.

Title, Branch, and Commits

  • PR title follows Conventional Commits (e.g. feat(nvidia): …, fix(cuda/gemm): …).
  • Branch name follows <type>/xxx-yyyy-zzzz where <type> matches the PR title's Conventional Commits type and words are joined with hyphens (see CONTRIBUTING.md §Branches).
  • Each commit message follows Conventional Commits.
  • Small PR is a single squashable commit; or, for a large PR, every commit is meaningful, well-formed, and independently reviewable (see CONTRIBUTING.md §Pull Requests).
  • No stray merge commits from main — the branch is rebased cleanly on top of the current main.
  • No fixup! / squash! / wip commits remain.
  • N/A Existing PR/branch/commit that followed the legacy issue format.

Scope and Design

  • Changes are minimal — nothing unrelated to the stated motivation was added (CONTRIBUTING.md §Code/General).
  • No dead code, commented-out blocks, debug prints, printf/std::cout/print(...) left behind, or TODO without an owner and issue link.
  • No unrelated formatting churn that would obscure the diff.
  • N/A Public API changes (if any) are intentional, documented, and reflected in affected callers/tests.

General Code Hygiene (applies to all languages)

  • The code is self-explanatory; comments were added only where the why is non-obvious (CONTRIBUTING.md §Code/General).
  • Every modified or added file ends with a single trailing newline (CONTRIBUTING.md §Code/General).
  • No trailing whitespace, tab/space mixing, or stray BOMs.
  • Identifiers in comments and error messages are wrapped in backticks (e.g. the `seqlens_k` tensor) (CONTRIBUTING.md §Code/General).
  • All comments and error messages are in English (CONTRIBUTING.md §Code/General).
  • Comments and error messages are complete sentences — capitalized first letter, terminal punctuation — unless the language/framework convention says otherwise (CONTRIBUTING.md §Code/General; §Python).

C++ Specific (if C++ files changed)

  • N/A Code follows the Google C++ Style Guide strictly.
  • N/A Error and warning message wording follows the LLVM Coding Standards (CONTRIBUTING.md §C++).
  • N/A Constructor initializer list order matches member declaration order (CONTRIBUTING.md §C++).
  • N/A No raw new/delete; RAII / smart pointers / existing allocators are used.
  • N/A Changed files are formatted by scripts/format.py.
  • N/A No changes/reference to csrc/models/llama_legacy/.

Python Specific (if Python files changed)

  • N/A Code is PEP 8 compliant.
  • N/A Comments are complete English sentences, starting with a capital letter and ending with punctuation; Markdown backticks are used for code references (CONTRIBUTING.md §Python).
  • N/A Docstrings (if any) follow PEP 257 (CONTRIBUTING.md §Python).
  • N/A Changed files are formatted by scripts/format.py.
  • N/A No changes/reference to python/infinilm/auto_config.py.

Testing

  • N/A For any platform that could not be tested, an explicit reason is given in the table and a reviewer with access has been tagged.
  • N/A Passed single request test (examples/test_infer.py), or specify the reason for skipping.
  • N/A Passed offline performance test (examples/bench.py), or specify the reason for skipping.
  • N/A Passed sanity test (test/bench/test_benchmark.py), or specify the reason for skipping.
  • N/A Passed service test (python/infinilm/server/inference_server.py + scripts/test_perf.py), or specify the reason for skipping.

Build, CI, and Tooling

  • N/A The project builds cleanly from a fresh directory on at least one affected platform.

Documentation

  • N/A README.md, CONTRIBUTING.md, or inline docs updated when behavior, build flags, or developer workflow changed.
  • N/A Any user-visible breaking change is called out explicitly under "Motivation" and in the commit/PR title with a ! or BREAKING CHANGE: footer.

Security and Safety

  • N/A No secrets, access tokens, internal URLs, customer data, or personal hardware identifiers have been committed.
  • N/A Third-party code is license-compatible and attributed.
  • N/A No unsafe pointer arithmetic, uninitialized reads, or missing bounds checks were introduced.

@wooway777 wooway777 requested a review from a team May 8, 2026 09:23
@wooway777 wooway777 force-pushed the chore/standard-contribution-requirements branch from 42d2423 to 8bde7e9 Compare May 8, 2026 09:25
@wooway777 wooway777 changed the title Chore/standard contribution requirements chore/standard contribution requirements May 8, 2026
@wooway777 wooway777 changed the title chore/standard contribution requirements chore: add standard contribution requirements May 8, 2026
@wooway777 wooway777 force-pushed the chore/standard-contribution-requirements branch 2 times, most recently from 8525d70 to f453b6f Compare May 8, 2026 10:14
@wooway777 wooway777 force-pushed the chore/standard-contribution-requirements branch from f453b6f to d93ca28 Compare May 8, 2026 12:04

### Title, Branch, and Commits

- [ ] PR **title** follows [Conventional Commits](https://www.conventionalcommits.org/) (e.g. `feat(nvidia): …`, `fix(cuda/gemm): …`).
Copy link
Copy Markdown
Collaborator

@PanZezhong1725 PanZezhong1725 May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commit里issue号还需要加吗

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commit里issue号还需要加吗

新的就不用了吧,感觉好像本来也没把issue号用起来

@wooway777 wooway777 merged commit bc0b7e5 into main May 9, 2026
@wooway777 wooway777 deleted the chore/standard-contribution-requirements branch May 9, 2026 12:34
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.

add standard contribution requirements

2 participants