|
3 | 3 | Contributing packages
|
4 | 4 | *********************
|
5 | 5 |
|
6 |
| -To submit a package to the ``conda-forge`` channel, add its ``recipe`` and licence to the ``staged-recipes`` repository and create a pull request. Once the pull request is merged, the package becomes available on the ``conda-forge`` channel. |
| 6 | +The contribution process can be broken down into three steps: |
7 | 7 |
|
8 |
| -The sections below provide detailed instructions on contributing packages to conda-forge. |
| 8 | +* Step 1. Staging process (add recipe and license). |
9 | 9 |
|
| 10 | + With the help of :ref:`the staging process <creating_recipes>`, add a package's recipe and license to the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`__ and create a PR. |
| 11 | + |
| 12 | +* Step 2. Post staging process. |
| 13 | + |
| 14 | + Once your PR, has been merged, take a look at our :ref:`post_staging_process` to know what follows. |
| 15 | + |
| 16 | +* Step 3. Maintaining the package. |
| 17 | + |
| 18 | + Contributing a package to ``conda-forge`` makes you the maintainer of that package. |
| 19 | + Learn more about the :ref:`roles of a maintainer <maintainer_role>`. |
| 20 | + |
| 21 | +The sections below will add more details about each step. |
10 | 22 |
|
11 | 23 | .. _creating_recipes:
|
12 | 24 |
|
@@ -115,9 +127,10 @@ After merging the :term:`PR`, our :term:`CI` infrastructure will build the packa
|
115 | 127 |
|
116 | 128 | If you have questions or have not heard back for a while, you can notify us by including ``@conda-forge/staged-recipes`` in your GitHub message.
|
117 | 129 |
|
| 130 | +.. _post_staging_process: |
118 | 131 |
|
119 | 132 | Post staging process
|
120 |
| --------------------- |
| 133 | +==================== |
121 | 134 |
|
122 | 135 | * After the PR is merged, our :term:`CI` services will create a new git repo automatically. For example, the recipe for a package named ``pydstool`` will be moved to a new repository `https://github.com/conda-forge/pydstool-feedstock <https://github.com/conda-forge/pydstool-feedstock>`_. This process is automated through a CI job on the ``conda-forge/staged-recipes`` repo. It sometimes fails due to API rate limits and will automatically retry itself. If your feedstock has not been created after a day or so, please get in touch with the ``conda-forge/core`` team for help.
|
123 | 136 | * CI services will be enabled automatically and a build will be triggered automatically which will build the conda package and upload to `https://anaconda.org/conda-forge <https://anaconda.org/conda-forge>`_
|
@@ -153,10 +166,12 @@ These are the CI configuration files for service providers like Azure and Travis
|
153 | 166 | conda-forge.yml
|
154 | 167 | ................
|
155 | 168 |
|
156 |
| -This file is used to configure how the feedstock is set up and built. Making any changes in this file usually requires `rerendering the feedstock <https://conda-forge.org/docs/maintainer/updating_pkgs.html#dev-update-rerender>`__. |
| 169 | +This file is used to configure how the feedstock is set up and built. Making any changes in this file usually requires :ref:`dev_update_rerender`. |
| 170 | + |
| 171 | +.. _maintainer_role: |
157 | 172 |
|
158 | 173 | Maintainer role
|
159 |
| ---------------- |
| 174 | +=============== |
160 | 175 |
|
161 | 176 | The maintainer's job is to:
|
162 | 177 |
|
@@ -841,12 +856,12 @@ Recipe Maintainer
|
841 | 856 | A maintainer is an individual who is responsible for maintaining and updating one or more feedstock repositories and packages as well as their future versions. They have push access to the feedstock repositories of only the packages they maintain and can merge pull requests into it.
|
842 | 857 |
|
843 | 858 | Contributing a recipe for package makes you the ``maintainer`` of that package automatically.
|
844 |
| -See `Maintainers Role <https://conda-forge.org/docs/maintainer/adding_pkgs.html#maintainer-role>`__ and `Maintaining Packages <https://conda-forge.org/docs/maintainer/updating_pkgs.html#maintaining-packages>`__ to learn more about what are the things that maintainers do. |
| 859 | +See :ref:`maintainer_role` and :ref:`maintaining_pkgs` to learn more about what are the things that maintainers do. |
845 | 860 | If you wish to be a maintainer of a certain package, you should contact current maintainers and open an issue in that package's feedstock with the following command:
|
846 | 861 |
|
847 | 862 | ``@conda-forge-admin, please add user @username``
|
848 | 863 |
|
849 |
| -where username is the GitHub username of the new maintainer to be added. Please refer to `Becoming a maintainer <https://conda-forge.org/docs/orga/guidelines.html#becoming-a-maintainer>`__ and `Updating the maintainer <https://conda-forge.org/docs/maintainer/updating_pkgs.html#updating-the-maintainer-list>`__ for detailed instructions. |
| 864 | +where username is the GitHub username of the new maintainer to be added. Please refer to :ref:`becoming_a_maintainer` and :ref:`maint_updating_maintainers` for detailed instructions. |
850 | 865 |
|
851 | 866 | .. _feedstock_name:
|
852 | 867 |
|
|
0 commit comments