Skip to content

Commit c3d769c

Browse files
authored
Merge pull request #1340 from prachi237/guidelines
Modified(improved) the 'Guidelines' section
2 parents 08d1a23 + 96eb9b1 commit c3d769c

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

src/orga/guidelines.rst

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,32 @@ Transferring to conda-forge
77
This document intends to layout some guidelines on the transfer of
88
`conda-recipes <https://github.com/conda/conda-recipes>`__ and
99
`anaconda-recipes <https://github.com/ContinuumIO/anaconda-recipes>`__
10-
to conda-forge. These aren't hard and fast rules and are open reasonable
10+
to conda-forge. These aren't hard and fast rules, instead are open reasonable
1111
interpretation and reviewer judgement.
1212

13-
It is the aspiration that almost all recipes from those repos shall be
13+
It is anticipated that almost all recipes from those repos shall be
1414
proposed for addition here, though it may be decided that a few don't
1515
actually belong or should not be supported anymore.
1616

17-
When adding a package from either location, inspect the commit history
18-
to see who has made changes to the recipe in the past. Anyone who has
19-
touched the recipe should be pinged about it getting added here. They
20-
should also be consulted with regards to whether the recipe needs any
17+
While adding a package from either location, inspect the commit history
18+
to see who had made changes to the recipe in the past. Anyone who has
19+
touched the recipe should be pinged about it, so that they can be added here. They
20+
should also be consulted with regards, if the recipe needs any
2121
tweaks before being added. Also, they should be asked if they would
22-
like to be added as maintainers. Only if they give express permission
23-
to be adding as a maintainer should they be added to the maintainer list.
24-
In all cases when porting a recipe, you should add yourself as a
25-
maintainer. Some contributors to these repos were quite prolific, but may
22+
like to be added as maintainers. Only if they give express permission,
23+
to take up the role as a maintainer the only they should be added in the maintainer list.
24+
25+
In all cases while porting a recipe, you should add yourself as a
26+
maintainer. Some contributors to these repos might be quite prolific, but may
2627
not be as actively engaged. If they specify they only want to be contacted
27-
for certain recipes or none at all, please respect their wishes also add
28-
make note of what recipes (if any) they would like to be notified for. If
28+
for certain recipes or none at all, please respect their wishes add them too.
29+
Make note of what recipes (if any) they would like to be notified for. If
2930
they are no longer interested in any conda recipes, make that note here
3031
as well. Before contacting anyone please consult the list in this
3132
`issue <https://github.com/conda-forge/staged-recipes/issues/139>`__
3233
to see if that contributor has restrictions.
3334

34-
When porting make sure the recipe follows the linting specifications.
35+
While porting make sure the recipe follows the linting specifications.
3536
The section order should go ``package``, ``source``, ``build``,
3637
``requirements``, ``test``, ``about``, ``extra/recipe-maintainers``. It
3738
is recommended to add a ``build`` section with the ``number`` set to
@@ -61,7 +62,7 @@ the build order and the necessary build matrix (e.g. which python versions to
6162
build against). From a practical perspective, there are limitations on the
6263
continuous integration resources and also on what reviewers are able/willing
6364
to review in a single pull request.
64-
A large pull request with many recipes makes it more difficult to review.
65+
A large pull request with numerous recipes makes it more difficult to review.
6566
If the recipes make it through these two constraints and are merged, race
6667
conditions amongst the different feedstocks may require work by you and/or
6768
core maintainers to restart them in such a way to build everything in a
@@ -102,9 +103,9 @@ Fixing Broken Packages
102103
Sometimes you need to remove a package from the conda-forge channel on Anaconda.org. The reasons
103104
for this are many, but the ones that immediately come to mind are:
104105

105-
* incorrect pinnings or metadata
106-
* packages being renamed
107-
* broken package contents
106+
* Incorrect pinnings or metadata
107+
* Packages being renamed
108+
* Broken package contents
108109

109110
We prefer to not remove packages for the following reasons:
110111

@@ -114,7 +115,7 @@ We prefer to not remove packages for the following reasons:
114115
4. Not as community friendly (leaves no opportunity to review decision).
115116
5. Blocks anyone from inspecting the broken packages.
116117

117-
Instead, if possible, we prefer to take one of the following actions.
118+
Instead, if possible, we prefer to take one of the following actions:
118119

119120
1. If the only issue is in the package metadata, we can directly patch it using
120121
the `repo data patches feedstock <https://github.com/conda-forge/conda-forge-repodata-patches-feedstock>`__.

0 commit comments

Comments
 (0)