Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Bug report
description: Report a reproducible FastaGuard problem.
title: "[Bug]: "
labels: [bug]
body:
- type: markdown
attributes:
value: "Please remove private sequence data. A minimal synthetic FASTA reproducer is preferred."
- type: input
id: version
attributes:
label: FastaGuard version
description: Include the output of `fastaguard --version`.
validations:
required: true
- type: input
id: operating-system
attributes:
label: Operating system
description: Include the operating system and version.
validations:
required: true
- type: dropdown
id: installation-method
attributes:
label: Installation method
options:
- Bioconda
- Container image
- Release binary
- Source build
- Other
validations:
required: true
- type: textarea
id: command
attributes:
label: Exact command
description: Paste the complete command and relevant options.
render: shell
validations:
required: true
- type: textarea
id: reproducer
attributes:
label: Minimal FASTA reproducer or safe description
description: Share a minimal synthetic FASTA or describe the input safely.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected result
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual result
description: Include output, error messages, and generated report details.
validations:
required: true
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Security vulnerability report
url: https://github.com/ehsanestaji/FastaGuard/security/policy
about: Read the security policy for the private reporting contact.
63 changes: 63 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
name: Feature request
description: Suggest a focused improvement to FastaGuard.
title: "[Feature]: "
labels: [enhancement]
body:
- type: markdown
attributes:
value: "Describe the workflow problem and avoid including private sequence data."
- type: input
id: version
attributes:
label: FastaGuard version
description: Include the version you use, if applicable.
validations:
required: true
- type: input
id: operating-system
attributes:
label: Operating system
description: Include the operating system and version, if applicable.
validations:
required: true
- type: dropdown
id: installation-method
attributes:
label: Installation method
options:
- Bioconda
- Container image
- Release binary
- Source build
- Other
validations:
required: true
- type: textarea
id: command
attributes:
label: Exact command
description: Show the current workflow command, if applicable.
render: shell
validations:
required: true
- type: textarea
id: reproducer
attributes:
label: Minimal FASTA reproducer or safe description
description: Provide a minimal synthetic example or safe workflow description.
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected result
description: Describe the outcome that would make the workflow work better.
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual result
description: Describe the current behavior or limitation.
validations:
required: true
24 changes: 24 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Scoped change description

<!-- Describe the user-facing change and why it belongs in FastaGuard. -->

## Tests

<!-- List commands run and any relevant results. -->

## Contract impact

- [ ] No public contract change.
- [ ] Public contract changed; JSON, TSV, HTML, schema, and finding catalog impacts are described above.

## Documentation impact

- [ ] No documentation change is needed.
- [ ] Documentation, examples, or release notes were updated.

## Review checklist

- [ ] Tests cover changed behavior or explain why tests are not applicable.
- [ ] DCO: every commit includes a `Signed-off-by:` line.
- [ ] Attribution-trace review: the change has no unwanted authorship or tool-provenance traces.
- [ ] The contribution stays within FastaGuard's FASTA-level preflight scope.
38 changes: 36 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ on:
pull_request:

jobs:
multiqc-plugin:
name: MultiQC plugin (Python ${{ matrix.python }}, MultiQC ${{ matrix.multiqc }})
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python: ["3.10", "3.14"]
multiqc: ["1.28", "1.35"]

steps:
- name: Checkout
uses: actions/checkout@v6.0.2

- name: Install Python
uses: actions/setup-python@v6
with:
python-version: ${{ matrix.python }}

- name: Install Python test dependencies
run: python3 -m pip install --requirement requirements-test.txt

- name: Test built MultiQC plugin
env:
FASTAGUARD_MULTIQC_VERSION: ${{ matrix.multiqc }}
run: python3 -m pytest -q tests/python/test_multiqc_plugin.py

rust:
name: Rust quality gate
runs-on: ubuntu-latest
Expand All @@ -20,6 +46,11 @@ jobs:
with:
components: rustfmt, clippy

- name: Install Python
uses: actions/setup-python@v6
with:
python-version: "3.12"

- name: Cache Cargo
uses: Swatinem/rust-cache@v2

Expand All @@ -32,8 +63,11 @@ jobs:
- name: Run clippy
run: cargo clippy --locked --all-targets --all-features -- -D warnings

- name: Check adoption assets
run: python3 -m unittest tests.python.test_adoption_assets -v
- name: Install Python test dependencies
run: python3 -m pip install --requirement requirements-test.txt

- name: Run Python tests
run: python3 -m pytest -q tests/python

- name: Build Docker image
run: docker build -t fastaguard:ci .
Expand Down
144 changes: 0 additions & 144 deletions AGENTS.md

This file was deleted.

Loading