Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added instructions on how to use Gitpod for contributing. #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions _sources/contributor/gitpod.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
Contribution using gitpod
+++++++++++++++++++++

.. contents::
:local:
:backlinks: entry

.. _open_gitpod:

1. Open preconfigured Gitpod session
~~~~~~~~~~~~~~~~~~

To get started right away without needing to install any tools, you can launch a gitpod session
on the following repository : ' bioconda_recipepod <https://github.com/FloWuenne/bioconda_recipepod>'.

This will open a new Gitpod session with the following tools pre-installed:
- conda
- mamba
- grayskull
- bioconda-utils

.. _create_branch:

2. Create a branch in the bioconda-recipes folder
~~~~~~~~~~~~~~~~~~

The Gitpod environment by default enters a clone of the bioconda recipes repository, so you can directly get started with your recipe. Create a branch and either modify an existing recipe or create a new one using `conda skeleton` or `grayskull`.

.. _lint_recipe:

3. Lint your recipe
~~~~~~~~~~~~~~~~~~

To test if your recipe lints, run `bioconda-utils lint --git-range master` or `bioconda-utils lint --packages mypackage`.

.. _test_recipe:

4. Test your recipe
~~~~~~~~~~~~~~~~~~

To test if your recipe works, run `bioconda-utils build --docker --mulled-test --git-range master` or `bioconda-utils build --docker --mulled-test --packages mypackage`

.. _add_fork:

5. Add your fork as a remote
~~~~~~~~~~~~~~~~~~

Add your fork of bioconda recipes as a remote: `git remote add [name for your remote] [URL of your fork]`

.. _push_to_remote:

6. Push your changes to your fork
~~~~~~~~~~~~~~~~~~

Push your changes to your fork to open a Pull Request: `git push -u [name for your remote] [name of your branch]`


That is it, your recipe should now be on your fork and branch for you to be able to open a pull request to the official bioconda recipes repo.
3 changes: 2 additions & 1 deletion _sources/contributor/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ recipe you'd like to add.
The basic workflow is:

- Follow the :doc:`setup` instructions to get a local copy of the
recipes repository
recipes repository or use `Gitpod <https://www.gitpod.io/>` to develop your recipe in a preconfigured environment.

- Write a recipe or modify an existing one. A recipe consists of a
metadata file and (optionally) a shell script to install it. Here is
Expand All @@ -33,6 +33,7 @@ challenging to package. The topics below provide more details.

setup
workflow
gitpod
building-locally

troubleshooting
Expand Down