CI
56a195f1bb
Build pipeline: vsh-ci-template-bbg2t
Source commit: d97e3156fe
Source message: Rename biobase -> biobox
1.8 KiB
1.8 KiB
Base repository for reusable Viash components
This repository is a collection of reproducible and reusable Viash components.
Objectives
- Reusability: Facilitating the use of components across various projects and contexts.
- Reproducibility: Guaranteeing that bioinformatics analyses can be reliably replicated.
- Best Practices: Adhering to established standards in software development and bioinformatics.
Contributing
We encourage contributions from the community. To contribute:
- Fork the Repository: Start by forking this repository to your account.
- Develop Your Component: Create your Viash component, ensuring it aligns with our best practices (detailed below).
- Submit a Pull Request: After testing your component, submit a pull request for review.
Contribution Guidelines
The contribution guidelines describes which steps you should follow to contribute a component to this repository.
- Find a component to contribute
- Add config template
- Fill in the metadata
- Find a suitable container
- Create help file
- Create or fetch test data
- Add arguments for the input files
- Add arguments for the output files
- Add arguments for the other arguments
- Add a Docker engine
- Write a runner script
- Create test script
- Create a
/var/software_versions.txtfile
See the CONTRIBUTING file for more details.
Support and Community
For support, questions, or to join our community:
- Issues: Submit questions or issues via the GitHub issue tracker.
- Discussions: Join our discussions via GitHub Discussions.
License
This repository is licensed under an MIT license. See the LICENSE file for details.