Skip to content

Commit 4868ca8

Browse files
committed
add extra section-recipe maintainer and feedstock-name
1 parent 026cd0a commit 4868ca8

File tree

1 file changed

+31
-6
lines changed

1 file changed

+31
-6
lines changed

src/maintainer/adding_pkgs.rst

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

6-
7-
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
8-
on the ``conda-forge`` channel. Note that contributing a package makes you the ``maintainer`` of that package.
9-
10-
A maintainer is responsible for maintaining the feedstock repository and packages as well as their future versions and has push access to the feedstock repositories of only the packages it maintains.
11-
You can learn more about the roles of a maintainer `here. <https://conda-forge.org/docs/maintainer/adding_pkgs.html#maintainer-role>`__
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.
127

138
The sections below provide detailed instructions on contributing packages to conda-forge.
149

@@ -761,6 +756,36 @@ For some languages, the community provides tools which can automate this process
761756

762757
The correct and automated packaging of dependency licenses is an ongoing discussion. Please feel free to add your thoughs to `this <https://github.com/conda-forge/conda-forge.github.io/issues/1052>`__ discussion.
763758

759+
Extra
760+
-----
761+
762+
Recipe Maintainer
763+
..................
764+
765+
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.
766+
767+
Contributing a recipe for package makes you the ``maintainer`` of that package automatically.
768+
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.
769+
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:
770+
771+
``@conda-forge-admin, please add user @username``
772+
773+
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.
774+
775+
.. _feedstock_name:
776+
777+
Feedstock name
778+
..............
779+
780+
If you want the name of the feedstock different from the package name in the staged-recipes, you can use the ``feedstock-name`` directive in the recipe of that package, like this:
781+
782+
.. code-block:: yaml
783+
784+
extra:
785+
feedstock-name: <name>
786+
787+
Here, ``<name>`` is the name you would want for the feedstock.
788+
764789
Miscellaneous
765790
=============
766791

0 commit comments

Comments
 (0)