Skip to content

Add AGENTS.md and CONTRIBUTING.md#377

Open
tien-tong wants to merge 1 commit into
mainfrom
add-agent
Open

Add AGENTS.md and CONTRIBUTING.md#377
tien-tong wants to merge 1 commit into
mainfrom
add-agent

Conversation

@tien-tong

Copy link
Copy Markdown
Contributor

No description provided.

@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.07%. Comparing base (95fd99d) to head (f92c361).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #377   +/-   ##
=======================================
  Coverage   79.07%   79.07%           
=======================================
  Files          17       17           
  Lines        2079     2079           
  Branches      362      362           
=======================================
  Hits         1644     1644           
  Misses        300      300           
  Partials      135      135           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@asmacdo asmacdo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should drop a link to this into https://pennlinc-babs.readthedocs.io/en/stable/developer.html

Overall looks good to me!

Comment thread CONTRIBUTING.md
`docs/developer_how_to_test.rst`.
- Python style: run `ruff check .` and `ruff format --check .`.
- Shell scripts: run the shellcheck command used by GitHub Actions.
- Documentation: build with `python -m sphinx -W -b html docs docs/build/html`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to manually add a changelog entry?

Comment thread CONTRIBUTING.md
ruff check .
ruff format --check .
ruff check --fix
ruff format

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could shorten this by adding precommit and just referencing that.

Comment thread AGENTS.md
Comment on lines +11 to +13

Do not guess project conventions. If a workflow is not documented in
`CONTRIBUTING.md` or repository files, say so instead of inventing one.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

dupe of "Do not invent"

Comment thread CONTRIBUTING.md
```

## Command Line Entry Points

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
babs --help

Comment thread CONTRIBUTING.md
Comment on lines +314 to +318
The root `Makefile` has targets named `install`, `setup-user`, and `e2e` that
refer to `tests/e2e-slurm/install-babs.sh`, `tests/e2e-slurm/setup-user.sh`,
and `tests/e2e-slurm/main.sh`. If those scripts are absent in your checkout,
those targets will fail. The `clean` target does exist and removes the `slurm`
container and `.testdata`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That make file hasnt been updated for 2 years, and probably is just "dead". Should we remove it and references?

@tien-tong tien-tong added the enhancement New feature or request label May 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants