Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,18 @@ 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:
`<type>/<short-description>`, where `<type>` 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/.
- scripts: Changes isolated to a single script under scripts/ and subject to less rigorous review than changes to core code.
- docs: Documentation changes only.