Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 1.13 KB

Contributing

Branching

  1. Keep master (or main) as releasable.
  2. Do all release-candidate work on a dedicated branch first.
  3. Use short-lived topic branches for follow-up fixes.

Suggested branch names:

  • dev/prep-v0.1.1
  • fix/<topic>
  • docs/<topic>

Local Validation

Run package tests:

julia --project=. -e "using Pkg; Pkg.test()"

Run quality checks:

@'
using Pkg
Pkg.activate(; temp=true)
Pkg.develop(path=pwd())
Pkg.add("Aqua")
using Aqua, SpectralGraphWavelet
Aqua.test_all(SpectralGraphWavelet; persistent_tasks=false)
'@ | julia -

Build docs locally:

julia --project=docs -e "using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()"
julia --project=docs docs/make.jl

CI Workflows

  • CI.yml: tests on supported Julia versions and OS targets.
  • Documentation.yml: builds and deploys docs with Documenter.
  • CompatHelper.yml: opens dependency compat PRs automatically.
  • TagBot.yml: creates release tags and GitHub releases from registry merges.

Release Process

Follow RELEASE_CHECKLIST.md before triggering Registrator.