Add issue templates and cluster contribution guide - #36
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.mdwith 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 fromREADME.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.
linsalrob
marked this pull request as ready for review
August 5, 2026 06:37
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
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, orpawsey_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
.github/ISSUE_TEMPLATE/cluster_support.ymlgit diff --checkbash -n pawsey_lib/check_atavide_lite_env.shpython -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.