ai-space/heretic
3
0
Fork 0
mirror of https://github.com/p-e-w/heretic.git synced 2026-06-02 05:03:33 +02:00
Code Issues Packages Projects Releases Wiki Activity

ci: add style guide for Gemini

Browse Source
This commit is contained in:
Philipp Emanuel Weidmann
2026-01-09 14:58:56 +05:30
parent 09be09e12e
commit 1cfd09d7f3
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.gemini/styleguide.md
+9
View File
@@ -0,0 +1,9 @@
# Style guide and coding conventions
* Identifier names should not contain abbreviations unless those abbreviations are very widely used and understood (e.g. "KL divergence").
* Comments should start with a capital letter and end with a period. They should use correct grammar and spelling.
* Function and method signatures **must** be fully type-annotated, including the return type (if any).
* Every Python code file **must** start with an SPDX/Copyright header.
* Pull requests should implement one change, and one change only.
* PRs containing multiple semantically independent changes **must** be split into multiple PRs.
* PRs **must not** change existing code unless the changes are *directly related* to the PR. This includes changes to formatting and comments.