You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<!--Provide a general summary of your changes in the title above, for
2
+
example "Add AMR unit test for cell centered fields.". Please avoid
3
+
non-descriptive titles such as "Addresses issue #8576".-->
4
+
5
+
## PR Summary
6
+
7
+
<!--Please provide at least 1-2 sentences describing the pull request in
8
+
detail. Why is this change required? What problem does it solve?-->
9
+
10
+
<!--If it fixes an open issue, please link to the issue here.-->
11
+
12
+
## PR Checklist
13
+
14
+
<!-- Note that some of these check boxes may not apply to all pull requests -->
15
+
16
+
-[ ] Code passes cpplint
17
+
-[ ] New features are documented.
18
+
-[ ] Adds a test for any bugs fixed. Adds tests for new features.
19
+
-[ ] Code is formatted
20
+
-[ ] Changes are summarized in CHANGELOG.md
21
+
-[ ] Change is breaking (API, behavior, ...)
22
+
-[ ] Change is *additionally* added to CHANGELOG.md in the breaking section
23
+
-[ ] PR is marked as breaking
24
+
-[ ] Short summary API changes at the top of the PR (plus optionally with an automated update/fix script)
25
+
-[ ] Docs build
26
+
-[ ] Any contribution that was created or modified with the assistance of generative AI is disclosed here and in code following the [guidelines](https://github.com/parthenon-hpc-lab/athenapk/blob/main/CONTRIBUTING.md#use-of-agentic-coding)
They are subject to live evaluation and may change in the future.
129
+
130
+
In general, there are no limitations to the use of agentic coding/LLMs/... given that
131
+
- the usage is disclosed
132
+
- by adding `// This file was made in part with generative AI` to the file, and
133
+
- by clearly stating the extent of usage in the PR description
134
+
- the person submitting the PR keeps ownership/responsiblity of all changes (i.e., conducts a thorough review themself)
135
+
136
+
In addition, the following recommendations should be followed
137
+
- for large/feature-style PRs a `plan.md` document outlining the changes should be part of the PR. The file should be named by the PR number and placed in the `docs/plan_histories` folder.
138
+
- if possible, large feature-style PRs are split into smaller, logically separated chunks (to ease reviewing)
139
+
- condense/consolidate generated code (to ease maintenance) as it is (still) often much more verbose than necessary (and typical in the existing codebase)
140
+
- reviewers are expected to be much more skeptical and thorough compared to code written by long-term contributors, and possibly more willing to reject
141
+
122
142
### Formatting code
123
143
We use `clang-format` to automatically format the C++ code. If you have clang-format installed
124
144
locally, you can always execute `make format-athenapk` or `cmake --build . --target format-athenapk` from
0 commit comments