|
|
|
|
|
# Share scripts and pipelines
|
|
# Share scripts and pipelines
|
|
|
|
|
|
All MIB general scripts will be placed in one repository and a wiki page describing each one of them will maintained by Bioinfo team. In that respect we would like to ask you to make sure your scripts respects the [[MIB good coding practices]] before submitting it.
|
|
All MIB general scripts will be placed in one repository and a wiki page describing each one of them will maintained by Bioinfo team. In that respect we would like to ask you to make sure your scripts respects the [MIB good coding practices](MIB good coding practices) before submitting it.
|
|
|
|
|
|
## Sharing scripts
|
|
## Sharing scripts
|
|
|
|
|
|
To publish scripts in MIB general scripts, send the details on how to access the script(s) to bioinfo.mib@wur.nl and we will add it to MIB repository. We also need to make sure that all scripts are in a functional state before adding them. For that reason, your script should respect [[MIB good coding practices]] and we ask you to describe how to test it in the documentation and also provide a small test data (max 15mins run).
|
|
To publish scripts in MIB general scripts, send the details on how to access the script(s) to bioinfo.mib@wur.nl and we will add it to MIB repository. We also need to make sure that all scripts are in a functional state before adding them. For that reason, your script should respect [MIB good coding practices](MIB good coding practices) and we ask you to describe how to test it in the documentation and also provide a small test data (max 15mins run).
|
|
|
|
|
|
Modifying an existing script can be made in 2 ways:
|
|
Modifying an existing script can be made in 2 ways:
|
|
|
|
|
... | @@ -12,15 +13,15 @@ Modifying an existing script can be made in 2 ways: |
... | @@ -12,15 +13,15 @@ Modifying an existing script can be made in 2 ways: |
|
|
|
|
|
Fork the scripts repository to your private repository (on gitlab), make the modifications then make a pull request. The Bioinfo team will make sure scripts are still working before merging it to the general MIB repository.
|
|
Fork the scripts repository to your private repository (on gitlab), make the modifications then make a pull request. The Bioinfo team will make sure scripts are still working before merging it to the general MIB repository.
|
|
|
|
|
|
### Become a developer
|
|
### Becoming a developer
|
|
|
|
|
|
You may request to become a developer for the scripts repository, if accepted you can clone the repository and make your modifications.
|
|
You may request to become a developer for the scripts repository, if accepted you can clone the repository and make your modifications.
|
|
Here is how to safely work in the scripts repository.
|
|
Here is how to safely work in the scripts repository.
|
|
|
|
|
|
1. Open a new [[issue]](Issues) clearly describing the modifications you want to make.
|
|
1. Open a new [issue](https://git.wur.nl/afsg-microbiology/scripts/scripts/-/issues) clearly describing the modifications to be made.
|
|
2. Make a new branch name after the issue
|
|
2. Make a new branch named after the issue
|
|
3. Make your modifications in the new branch, + commit & push
|
|
3. Make your modifications in the new branch and commit & push
|
|
4. Test that everything is working fine
|
|
4. Make sure the script works fine
|
|
5. Merge the Master branch to your new branch to make sure all modifications done after you made your branch are in the branch
|
|
5. Merge the Master branch to your new branch to make sure it integrates all the latest modifications
|
|
6. Merge your branch to the master
|
|
6. Merge your branch to the master, to make sure your modifications are available on the master branch
|
|
7. Close the issue + delete the branch |
|
7. Close the issue and delete the branch |
|
\ No newline at end of file |
|
\ No newline at end of file |