Skip to content

update method layout docs and add a CI check for it - #220

Merged
lacava merged 1 commit into
masterfrom
dev
Aug 13, 2026
Merged

update method layout docs and add a CI check for it#220
lacava merged 1 commit into
masterfrom
dev

Conversation

@lacava

@lacava lacava commented Aug 13, 2026

Copy link
Copy Markdown
Member

CONTRIBUTING.md and the PR template still described the old single-directory layout, from before regressor.py moved into experiment/methods/ (b5c5c96). back then CI copied the files over via scripts/copy_algorithm_files.sh, so contributors only touched algorithms/. that script is gone but the docs never got updated, and nothing catches the difference. the build-and-test matrix comes from ls algorithms/, so a method added only under experiment/methods/ never gets a job and still goes all green (see #211).

  • CONTRIBUTING.md documents where files go and why it's split that way
  • PR template reorganized around the two directories
  • local_ci.sh now wraps the docker commands instead of the old conda flow
  • scripts/check_method_layout.py checks the two dirs agree; runs in CI as validate-layout and gates build-and-test
  • fixes algorithms/eql/metadata.yml (invalid yaml), a missing experiment/methods/xgboost/init.py, and an invalid escape sequence in gplearn's regressor.py

CONTRIBUTING.md and the PR template still described the old single-directory
layout, from before regressor.py moved into experiment/methods/ (b5c5c96).
back then CI copied the files over via scripts/copy_algorithm_files.sh, so
contributors only touched algorithms/. that script is gone but the docs never
got updated, and nothing catches the mistake: the build-and-test matrix comes
from `ls algorithms/`, so a method added only under experiment/methods/ never
gets a job and still goes all green (see #211).

- CONTRIBUTING.md documents where files go and why it's split that way
- PR template reorganized around the two directories
- local_ci.sh now wraps the docker commands instead of the old conda flow
- scripts/check_method_layout.py checks the two dirs agree; runs in CI as
  validate-layout and gates build-and-test
- fixes algorithms/eql/metadata.yml (invalid yaml), a missing
  experiment/methods/xgboost/__init__.py, and an invalid escape sequence in
  gplearn's regressor.py
@lacava
lacava merged commit 5282455 into master Aug 13, 2026
88 of 90 checks passed
lacava added a commit that referenced this pull request Aug 13, 2026
#220 was squash-merged, so master carried a commit with the same content as
dev's 4629556 but a different hash. that made master and dev diverge and
turned the next promote into a phantom conflict in ci-docker.yml.

dev already contains everything in master, so this records the merge without
taking any content. master is an ancestor of dev again and the next promote
is a fast-forward.

going forward: squash contributor PRs into dev, but promote dev -> master
with a merge or fast-forward, never a squash.
@lacava lacava mentioned this pull request Aug 13, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant