Submitting Pull Requests
Thank you for contributing to BioNodulo! This page covers our contribution workflow and expectations.
Before you start
- Open an issue first for non-trivial changes so we can align on approach.
- Check existing issues and PRs to avoid duplication.
- For new nodes, follow Creating Custom Nodes.
Workflow
- Fork the repo and create a branch off
main:git checkout -b feat/bowtie2-node - Make your change. Keep PRs focused — one logical change per PR.
- Run checks locally:
pnpm lint pnpm build pnpm test - Commit using clear, conventional messages
(
feat:,fix:,docs:,chore:). - Push and open a PR against
bionodulo/bionodulo:main.
PR checklist
- Tests added or updated and passing.
- Lint and typecheck pass.
- Docs updated (including this site for user-facing changes).
- New nodes pin a container image version and declare accurate port types.
- PR description explains the why, not just the what.
Licensing
The core, editor, and desktop app are GPL-3.0. By contributing you agree your contribution is licensed under the project’s license. Documentation contributions are licensed CC BY 4.0.
Code review
A maintainer will review your PR. Expect a few rounds of feedback — it keeps the codebase healthy. Be responsive and keep the discussion in the PR thread.
Community
- Discord — chat with maintainers and other contributors.
- GitHub Discussions — design discussions and questions.
Reporting security issues
Please do not open public issues for security vulnerabilities. Email
security@bionodulo.com instead; we’ll coordinate a fix and disclosure.