From 4868ca8f541ec4a82cd910f33eccee5c4e8b86bd Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Fri, 10 Jun 2022 17:30:55 +0530 Subject: [PATCH 1/3] add extra section-recipe maintainer and feedstock-name --- src/maintainer/adding_pkgs.rst | 37 ++++++++++++++++++++++++++++------ 1 file changed, 31 insertions(+), 6 deletions(-) diff --git a/src/maintainer/adding_pkgs.rst b/src/maintainer/adding_pkgs.rst index a35fde3982..37296bc9fc 100644 --- a/src/maintainer/adding_pkgs.rst +++ b/src/maintainer/adding_pkgs.rst @@ -3,12 +3,7 @@ Contributing packages ********************* - -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. Note that contributing a package makes you the ``maintainer`` of that package. - -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. -You can learn more about the roles of a maintainer `here. `__ +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. The sections below provide detailed instructions on contributing packages to conda-forge. @@ -761,6 +756,36 @@ For some languages, the community provides tools which can automate this process The correct and automated packaging of dependency licenses is an ongoing discussion. Please feel free to add your thoughs to `this `__ discussion. +Extra +----- + +Recipe Maintainer +.................. + +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. + +Contributing a recipe for package makes you the ``maintainer`` of that package automatically. +See `Maintainers Role `__ and `Maintaining Packages `__ to learn more about what are the things that maintainers do. +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: + +``@conda-forge-admin, please add user @username`` + +where username is the GitHub username of the new maintainer to be added. Please refer to `Becoming a maintainer `__ and `Updating the maintainer `__ for detailed instructions. + +.. _feedstock_name: + +Feedstock name +.............. + +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: + +.. code-block:: yaml + + extra: + feedstock-name: + +Here, ```` is the name you would want for the feedstock. + Miscellaneous ============= From 791ee22eaeb067992c0c600667f2c73534d0192c Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Fri, 10 Jun 2022 17:35:25 +0530 Subject: [PATCH 2/3] add explicit tag for recipe maintainer section --- src/maintainer/adding_pkgs.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/maintainer/adding_pkgs.rst b/src/maintainer/adding_pkgs.rst index 37296bc9fc..c74ad27130 100644 --- a/src/maintainer/adding_pkgs.rst +++ b/src/maintainer/adding_pkgs.rst @@ -759,6 +759,8 @@ For some languages, the community provides tools which can automate this process Extra ----- +.. _recipe_maintainer: + Recipe Maintainer .................. From 6f2914c1f840c29d741e49521e57c34d406cb925 Mon Sep 17 00:00:00 2001 From: Surbhi Sharma Date: Tue, 14 Jun 2022 14:25:45 +0530 Subject: [PATCH 3/3] Fix grammatical mistakes --- src/maintainer/adding_pkgs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/maintainer/adding_pkgs.rst b/src/maintainer/adding_pkgs.rst index c74ad27130..6283d0a72c 100644 --- a/src/maintainer/adding_pkgs.rst +++ b/src/maintainer/adding_pkgs.rst @@ -779,7 +779,7 @@ where username is the GitHub username of the new maintainer to be added. Please Feedstock name .............. -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: +If you want the name of the feedstock to be different from the package name in the staged-recipes, you can use the ``feedstock-name`` directive in the recipe of that package, like this: .. code-block:: yaml