Build branch v0.1 with version v0.1 (373be82)
Build pipeline: viash-hub.craftbox.v0.1-4f4mc
Source commit: 373be82129
Source message: Bump viash to 0.9.0-RC7 (#6)
This commit is contained in:
72
README.md
Normal file
72
README.md
Normal file
@@ -0,0 +1,72 @@
|
||||
|
||||
|
||||
# 🪡📦 craftbox
|
||||
|
||||
[](https://web.viash-hub.com/packages/craftbox)
|
||||
[](https://github.com/viash-hub/craftbox)
|
||||
[](https://github.com/viash-hub/craftbox/blob/main/LICENSE)
|
||||
[](https://github.com/viash-hub/craftbox/issues)
|
||||
[](https://viash.io)
|
||||
|
||||
A collection of custom-tailored scripts and applied tools.
|
||||
|
||||
## Objectives
|
||||
|
||||
- **Reusability**: Facilitating the use of components across various
|
||||
projects and contexts.
|
||||
- **Reproducibility**: Ensuring that components are reproducible and can
|
||||
be easily shared.
|
||||
- **Best Practices**: Adhering to established standards in software
|
||||
development and bioinformatics.
|
||||
|
||||
## Contributing
|
||||
|
||||
We encourage contributions from the community. To contribute:
|
||||
|
||||
1. **Fork the Repository**: Start by forking this repository to your
|
||||
account.
|
||||
2. **Develop Your Component**: Create your Viash component, ensuring it
|
||||
aligns with our best practices (detailed below).
|
||||
3. **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.
|
||||
|
||||
1. Find a component to contribute
|
||||
2. Add config template
|
||||
3. Fill in the metadata
|
||||
4. Find a suitable container
|
||||
5. Create help file
|
||||
6. Create or fetch test data
|
||||
7. Add arguments for the input files
|
||||
8. Add arguments for the output files
|
||||
9. Add arguments for the other arguments
|
||||
10. Add a Docker engine
|
||||
11. Write a runner script
|
||||
12. Create test script
|
||||
13. Create a `/var/software_versions.txt` file
|
||||
|
||||
See the
|
||||
[CONTRIBUTING](https://github.com/viash-hub/craftbox/blob/main/CONTRIBUTING.md)
|
||||
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](https://github.com/viash-hub/craftbox/issues).
|
||||
- **Discussions**: Join our discussions via [GitHub
|
||||
Discussions](https://github.com/viash-hub/craftbox/discussions).
|
||||
|
||||
## License
|
||||
|
||||
This repository is licensed under an MIT license. See the
|
||||
[LICENSE](https://github.com/viash-hub/craftbox/blob/main/LICENSE) file
|
||||
for details.
|
||||
Reference in New Issue
Block a user