diff --git a/Documentation/adding packages.md b/Documentation/adding packages.md new file mode 100644 index 0000000000..6a18764d96 --- /dev/null +++ b/Documentation/adding packages.md @@ -0,0 +1,31 @@ +# How to add packages to repo +Thanks for you interest in contributing packages to repo. Before submitting packages make sure your `PKGBUILD` is in line with packaging guidelines as outlined in [Arch Wiki](https://wiki.archlinux.org/title/PKGBUILD) and can be built in [clean chroot](https://wiki.archlinux.org/title/DeveloperWiki:Building_in_a_clean_chroot#Classic_way). This document also assumes you have signed up for github account and has setup ssh keys as outlined in github [documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) +1. create a fork of the [Bioarchlinux Packages](https://github.com/BioArchLinux/Packages) repo and clone it locally. +``` +git clone +``` +2. Create a new branch for the package you wish to add. +``` +git checkout -b +``` +3. Set bioarchlinux repo as upstream for the branch. +``` +git remote add upstream https://github.com/BioArchLinux/Packages.git +``` +4. make the required changes such as adding respective package folder containing PKGBUILD and lilac.yaml files into the **Bioarchlinux** folder. The folder structure should look like this, +``` +BioArchLinux// + ├── lilac.yaml + └── PKGBUILD +``` +5. commit the changes by +``` +git add +git commit -m "pkgname: adding version *xxx.yyy*" +``` +6. push the changes by, +``` +git push -u origin +``` +7. [ctrl]+left click the output URL to open pull request in a browser. +8. Wait for review and approval for PR to be merged. diff --git a/README.md b/README.md index 2a7c1b474f..cdfb033fbc 100644 --- a/README.md +++ b/README.md @@ -59,3 +59,6 @@ You can use [junest](https://github.com/fsquillace/junest) BioArchLinux image to > Zhang G. Hu Y. Drobot V. Staal J. Yi Y. Elliot MG. 2022. BioArchLinux: bioinformatics community with Arch Linux. F1000Research 11: 809. https://doi.org/10.7490/f1000research.1119039.1 [Get Bibtex Here](https://raw.githubusercontent.com/BioArchLinux/Packages/master/BioArchLinux.bibtex) + +## Submitting packages +Those wishing to submit 'PKGBUILD' for packages to repo please refer to [adding packages](/Documentation/adding%20packages.md) document