Skip to content

chore(queueserver): remove fork boilerplate from the service top level - #123

Open
Anthony Sligar (sligara7) wants to merge 1 commit into
NSLS2:mainfrom
sligara7:chore/qs-declutter
Open

chore(queueserver): remove fork boilerplate from the service top level#123
Anthony Sligar (sligara7) wants to merge 1 commit into
NSLS2:mainfrom
sligara7:chore/qs-declutter

Conversation

@sligara7

Copy link
Copy Markdown
Collaborator

Top-level cleanup of backend/queueserver_service so the directory reads as one service:

  • AUTHORS.rst and CONTRIBUTING.rst were cookiecutter boilerplate inherited from the fork (the AUTHORS file carried only an empty BNL maintainer line; CONTRIBUTING pointed at a stale personal fork with Python 2.7-era guidance). Removed; an ancestry-credits note in PARITY.md now points at the upstream contributor records, and the BSD-3 license text remains verbatim in LICENSE.
  • store_test_durations.sh (the pytest-split calibration script) moved into scripts/ with its two references updated (CI workflow comment, contributing docs).
  • docker-configs/ was audited and deliberately KEPT: it holds the LDAP compose file that scripts/start_LDAP.sh boots for the LDAPAuthenticator tests — operational, not residue.
  • egg-info/pycache were verified never-tracked and already gitignored; no change needed.

No code, dependency, or shim changes; packaging verified by building and importing the wheel from the tree under the frozen lock.

- Fold fork-era AUTHORS.rst/CONTRIBUTING.rst into PARITY.md ancestry
  credits (both were cookiecutter boilerplate; attribution now points at
  the upstream contributor records, license text stays in LICENSE)
- Move store_test_durations.sh into scripts/ and update the two
  references (queueserver-tests workflow comment, docs contributing page)
- docker-configs/ kept: referenced by README and scripts/start_LDAP.sh

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Cleans up the backend/queueserver_service top-level by removing inherited cookiecutter boilerplate, preserving required operational assets, and relocating a CI calibration helper script while keeping references accurate.

Changes:

  • Removed fork-inherited AUTHORS.rst and CONTRIBUTING.rst, and added an upstream attribution note to PARITY.md.
  • Moved the test-duration calibration helper to scripts/store_test_durations.sh and updated references in docs and CI workflow comments.
  • Updated contributing documentation to point to the new script location.

Reviewed changes

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
backend/queueserver_service/scripts/store_test_durations.sh Adds relocated helper script for pytest-split duration calibration.
backend/queueserver_service/PARITY.md Adds upstream contributor credit note replacing removed boilerplate files.
backend/queueserver_service/docs/source/contributing.rst Updates calibration instructions to reference the script’s new location.
backend/queueserver_service/CONTRIBUTING.rst Removes stale cookiecutter contributing boilerplate.
backend/queueserver_service/AUTHORS.rst Removes empty/stub authors boilerplate.
.github/workflows/queueserver-tests.yml Updates workflow comment to reference the script’s new location.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment on lines +141 to 142
Calibration is performed by running the script ``scripts/store_test_durations.sh`` locally,
which saves execution time for each test in the ```.test_durations`` file. The file then
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.

2 participants