Skip to content

Add issue templates and cluster contribution guide - #36

Merged
linsalrob merged 2 commits into
mainfrom
agent/cluster-support-issue-templates
Aug 5, 2026
Merged

Add issue templates and cluster contribution guide#36
linsalrob merged 2 commits into
mainfrom
agent/cluster-support-issue-templates

Conversation

@linsalrob

Copy link
Copy Markdown
Owner

What changed

  • add standard bug-report and feature-request templates
  • add a structured issue form that gathers the scheduler, partitions/queues, QoS and accounting rules, resource limits, storage, software environment, and tested submission details needed to port an existing cluster profile
  • add an inclusive contributor guide covering issue-first cluster contributions, branch-based profile adaptation, careful use of agentic AI, validation, and pull-request creation
  • document Pawsey Setonix as a worked example and link the new guides from the main README

Why

Atavide lite maintains separate scheduler scripts because HPC systems differ in scheduler policy, resources, storage, and software setup. Complete, structured requests reduce guesswork when adapting deepthought_minion, deepthought_shortread, pawsey_minion, or pawsey_shortread.

User impact

Contributors now have clear entry points for bugs, features, and cluster support. New cluster requests should include enough operational detail to produce a reviewable and testable profile.

Validation

  • parsed and structurally checked .github/ISSUE_TEMPLATE/cluster_support.yml
  • git diff --check
  • bash -n pawsey_lib/check_atavide_lite_env.sh
  • python -m unittest discover -s tests -v (3 tests passed)

Pawsey queue and resource information was checked against Pawsey's current Running Jobs on Setonix and Job Scheduling documentation.

Copilot AI lite review requested due to automatic review settings August 5, 2026 06:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds contributor-facing documentation and GitHub issue templates to make it easier to report bugs/features and to request/define new HPC cluster profiles with sufficient operational detail.

Changes:

  • Added CONTRIBUTING.md with guidance for issue-first contributions, cluster profile adaptation, and safe/verified use of agentic AI.
  • Added GitHub issue templates (bug report, feature request) plus a structured “New cluster support” issue form.
  • Added docs/cluster-support.md (including a Pawsey Setonix worked example) and linked the new guidance from README.md.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Links contribution docs and expands Setonix notes; points contributors to the cluster-support form/guide.
docs/cluster-support.md New guide describing what details are needed for a cluster port, with a Setonix worked example.
CONTRIBUTING.md New contribution guide covering issue-first workflow, branching, profile adaptation, validation, and PR creation.
.github/ISSUE_TEMPLATE/feature_request.md New feature request issue template.
.github/ISSUE_TEMPLATE/cluster_support.yml New structured issue form for requesting support for additional clusters.
.github/ISSUE_TEMPLATE/bug_report.md New bug report issue template.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CONTRIBUTING.md
Comment thread README.md Outdated
Comment thread README.md
@linsalrob
linsalrob marked this pull request as ready for review August 5, 2026 06:37
Copilot AI review requested due to automatic review settings August 5, 2026 06:59

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@linsalrob
linsalrob merged commit e88e2d3 into main Aug 5, 2026
1 check passed
@linsalrob
linsalrob deleted the agent/cluster-support-issue-templates branch August 5, 2026 07:15
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