Skip to content

Commit 019ddae

Browse files
authored
Merge pull request #1684 from chicken-biryani/ReDo-StagingProcess
Re-do first paragraph of 'contributing packages'.
2 parents 30ce129 + 1bf515c commit 019ddae

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

src/maintainer/adding_pkgs.rst

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,22 @@
33
Contributing packages
44
*********************
55

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:
77

8-
The sections below provide detailed instructions on contributing packages to conda-forge.
8+
* Step 1. Staging process (add recipe and license).
99

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.
1022

1123
.. _creating_recipes:
1224

@@ -115,9 +127,10 @@ After merging the :term:`PR`, our :term:`CI` infrastructure will build the packa
115127

116128
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.
117129

130+
.. _post_staging_process:
118131

119132
Post staging process
120-
--------------------
133+
====================
121134

122135
* 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.
123136
* 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
153166
conda-forge.yml
154167
................
155168

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:
157172

158173
Maintainer role
159-
---------------
174+
===============
160175

161176
The maintainer's job is to:
162177

@@ -841,12 +856,12 @@ Recipe Maintainer
841856
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.
842857

843858
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.
845860
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:
846861

847862
``@conda-forge-admin, please add user @username``
848863

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.
850865

851866
.. _feedstock_name:
852867

src/orga/guidelines.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,7 @@ Instead, if possible, we prefer to take one of the following actions:
134134
Adding the ``broken`` label to a package is more destructive than patching the repo data
135135
and thus we prefer repo data patches over labeling things as ``broken``.
136136

137+
.. _becoming_a_maintainer:
137138

138139
Becoming a maintainer
139140
=====================

0 commit comments

Comments
 (0)