Skip to content

Commit 9ea1e25

Browse files
committed
Added some code review tips to .github/copilot-instructions.md
Inspired by wanting some way to check the environment stays in sync.
1 parent 577d8df commit 9ea1e25

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,17 @@ Documentation lives in `documentation/source/` and is built with Sphinx (`make d
159159
- **Changed behavior**: Update relevant user guide section
160160
- **New features**: Add to `documentation/source/users/rmg/features.rst` or create and link to new `.rst` file
161161

162+
## Pull Request Review Guidance
163+
### Review Priorities
164+
- Verify changed behavior is covered by tests, or request targeted tests for uncovered paths.
165+
- Check that user-facing changes include required documentation updates (especially input syntax in `documentation/source/users/rmg/input.rst`).
166+
- Confirm Cython changes are complete (`.pyx`/`.pxd` parity, required setup wiring, and likely rebuild impact).
167+
- Watch for performance regressions in hot paths (`rmgpy/molecule/`, `rmgpy/solver/`, kinetics generation loops).
168+
169+
### Other checks
170+
- If `environment.yml` or `.conda/meta.yaml` change, verify they are consistent.
171+
- For changes that affect data loading or estimators, verify assumptions against RMG-database integration points in `rmgpy/data/rmg.py` and related loaders.
172+
162173
## Style Guidelines
163174
- Follow PEP 8 for new or modified code, but don't modify code just to fix style
164175
- Docstrings describe purpose, not implementation

0 commit comments

Comments
 (0)