mirrors/janet
1
0
Fork 0
mirror of https://github.com/janet-lang/janet synced 2026-06-03 11:12:15 +00:00
Code Issues 1 Releases Wiki Activity

Add suggestions.

Browse Source 
- No bot PRs
- Define "Large" code contribution

Also try to disuade users from using AI for one-line or simple changes, instead
preferring to treat that as "feedback" and rewrite instead.
This commit is contained in:
Calvin Rose
2026-03-13 17:27:32 -05:00
parent bab71feadb
commit 9880475262
1 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+17 -8
View File
@@ -37,6 +37,12 @@ may require changes before being merged.
do this indentation, or approximate as close as possible. There is a janet formatter
in [spork](https://github.com/janet-lang/spork.git) that can be used to format code as well.
Bot pull requests will not be accepted, and anonymous submissions, including
new accounts, unknown emails, and first time contributors will be subjected
to greater scrutiny and code reivew. Automatically generated and filed bug
reports MAY be ok, if they are of consistent and good quality, such as
OSSFuzz or well constructed CI pipelines.
## C style
For changes to the VM and Core code, you will probably need to know C. Janet is programmed with
@@ -95,11 +101,14 @@ timely manner. In short, if you want extra functionality now, then build it.
All usage of Large Language Models (LLMs), Neural Networks, "AI" tools, and
other tools such as software fuzzers or static analyzers must be disclosed.
This applies both pull requests, email patches, bug reports, and any meaningful
contribution to Janet's source code. Please also refrain from generative AI for
large amounts code that will be embedded in the Janet runtime, which include
all C source files as well as boot.janet. All submitted code should be both
inspected and understood by a human author, including test cases. Large and
obviously AI driven changes will be rejected. Be mindful and transparent on the
copyright implications of any submitted code. We will use discretion when
accepting LLM or generated test cases for bug reproductions.
This applies to pull requests, email patches, bug reports, and any other
meaningful contribution to Janet's source code. Please also refrain from using
generative AI for large amounts code that will be embedded in the Janet
runtime, which include all C source files as well as boot.janet. "Large" means
about 15 lines of C, and 5 lines of typically formatted Janet source code. All
code should be well and completely understood by the human author, including
test cases. Large and obviously AI-driven changes will be rejected. Be mindful
and transparent on the copyright implications of any submitted code. We will
use discretion when accepting LLM or generated test cases for bug
reproductions, one-line bug fixes, or typo fixes. Often, these can be trivially
rewritten to avoid the problem.