Skip to content

Commit f06aa69

Browse files
authored
Merge pull request #1484 from ForgottenProgramme/issue_1478
Made 'contributing packages' description precise and short
2 parents e4d5872 + 53186c4 commit f06aa69

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

src/maintainer/adding_pkgs.rst

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,20 @@ Contributing packages
44
*********************
55

66

7-
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 `PR <https://conda-forge.org/docs/misc/00_intro.html#glossary>`__ into it. See `Maintainers Role. <https://conda-forge.org/docs/maintainer/adding_pkgs.html#maintainer-role>`__
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.
89

9-
The list of maintainers of a feedstock package is recorded in the recipe of that package itself. Once you create a package, as a code owner, you automatically become a maintainer of it. In case you wish to be a maintainer of a certain package, you should ask for permission from its current maintainers and
10-
get your `gitub-id` added to the `recipe-maintainers` section in the recipe’s `meta.yaml`.
11-
`Please refer to Updating the maintainer list <https://conda-forge.org/docs/maintainer/updating_pkgs.html#updating-the-maintainer-list>`__ for detailed instructions.
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>`__
12+
13+
The sections below provide detailed instructions on contributing packages to conda-forge.
1214

1315

1416
.. _creating_recipes:
1517

1618
The staging process
1719
===================
1820

19-
This document presents an overview over how to contribute packages to conda-forge.
20-
21-
2221
Getting Started
2322
---------------
2423

@@ -34,9 +33,12 @@ There are multiple ways to get started:
3433

3534
Your final recipe should have no comments (unless they're actually relevant to the recipe, and not generic instruction comments), and follow the order in the example.
3635

37-
*If there are any details you are not sure about please open a pull request. The conda-forge team will be happy to answer your questions.*
36+
.. note::
37+
38+
If there are any details you are not sure about please create a pull request anyway. The conda-forge team will review it and help you make changes to it.
39+
3840

39-
In case you are building your first recipe using conda-forge, a step-by-step instruction and checklist that might help you with a successful build is provided in the following.
41+
In case you are building your first recipe using conda-forge, a step-by-step instruction and checklist that will help you with a successful build is provided below.
4042

4143
.. _staging_steps:
4244

0 commit comments

Comments
 (0)