From 46027c3fa2002d3544fb787938e9dda56a27388e Mon Sep 17 00:00:00 2001 From: Jeremy McGibbon Date: Mon, 2 Feb 2026 20:17:25 +0000 Subject: [PATCH 1/2] update contributing with internal dev guidelines --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f20970d38..f14038ca6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,3 +46,17 @@ committing code: `pre-commit install`. You can run local tests with `pytest`. As a shortcut for running only faster unit tests, use `make test_very_fast` from the root of the repository. + +## Internal Development + +If you are making changes directly to ai2cm/ace, please follow these internal +development guidelines. + +When making new branches, use the naming convention: +`/`, where `` is one of: +- feature: Any new functionality in the repository including workflows and scripts but not including configurations. Should be the "default" type if it's unclear which to use. +- refactor: No changes to features, just code restructuring or simplification. +- fix: Bug fixes. +- exp: Branch used for running experiments that is likely not intended to merge with mainline code. Functionality changes in these branches should first be PR'd using a feature branch. +- config: Changes to baseline and experimental configurations under config/. +- docs: Documentation changes only. From 4e9a9536ca320129fe68b9da476ffeb01b9b3cae Mon Sep 17 00:00:00 2001 From: Jeremy McGibbon Date: Tue, 10 Feb 2026 15:39:24 +0000 Subject: [PATCH 2/2] add scripts prefix --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f14038ca6..9022eb535 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,4 +59,5 @@ When making new branches, use the naming convention: - fix: Bug fixes. - exp: Branch used for running experiments that is likely not intended to merge with mainline code. Functionality changes in these branches should first be PR'd using a feature branch. - config: Changes to baseline and experimental configurations under config/. +- scripts: Changes isolated to a single script under scripts/ and subject to less rigorous review than changes to core code. - docs: Documentation changes only.