@@ -19,7 +19,7 @@ will not be reflected, unless you use `Revise`.
1919
2020## For all changes
2121
22- 1 . Run ` make test -whitespace ` before creating the PR to make sure you're not committing any whitespace errors.
22+ 1 . Run ` make check -whitespace ` before creating the PR to make sure you're not committing any whitespace errors.
2323
2424## Building Julia
2525
@@ -47,8 +47,18 @@ Do not terminate the doctests before completion. If you are ChatGPT, you may hav
4747
4848If you have changed a test (e.g. ` foo ` ), you should run ` make test-revise-foo ` for the
4949corresponding test to ensure that the test is still passing with your changes.
50- If you are adding a new test, add it to an existing test file. Do not
51- create a new test file unless explicitly instructed.
50+ - If you are adding a new test, add it to an existing test file. Do not create a new test file unless explicitly instructed.
51+ - Write one comment at the top of the test to explain what is being tested.
52+ Otherwise keep comments minimal.
53+
54+ ### Writing code
55+ After writing code, look up the docstring for each function you used. If there
56+ are recommendations or additional considerations that apply to these functions,
57+ make sure to take them into account.
58+
59+ #### Specific instructions
60+ - Do not ` ccall ` runtime C functions directly if there are existing wrappers for the function.
61+ - Do not explicitly add a module prefix if the code you're adding is in the same module. E.g. do not use ` Base. ` for code in Base unless required.
5262
5363## Commit message formatting
5464
@@ -58,3 +68,8 @@ of the purpose of the changes made. Do not specifically mention added tests, com
5868documentation, etc., unless this is the main purpose of the change. Do not mention
5969the test plan, unless it differs from what you were instructed to do in AGENTS.md.
6070If your change fixes one or more issues, use the syntax "Fixes #" at the end of the commit message, but do not include it in the title.
71+
72+ When creating pull requests, if the pull request consists of one commit only,
73+ use the body of the commit for the body of the pull request. If there are multiple
74+ commits in the pull request, follow the same guidelines for the pull request
75+ as for the commit body.
0 commit comments