@@ -7,8 +7,8 @@ Transferring to conda-forge
7
7
This document intends to layout some guidelines on the transfer of
8
8
`conda-recipes <https://github.com/conda/conda-recipes >`__ and
9
9
`anaconda-recipes <https://github.com/ContinuumIO/anaconda-recipes >`__
10
- to conda-forge. These aren't hard and fast rules, instead are open reasonable
11
- interpretation and reviewer judgement.
10
+ to conda-forge. These aren't hard and fast rules, instead are open to reasonable
11
+ interpretation and reviewer's judgement.
12
12
13
13
It is anticipated that almost all recipes from those repos shall be
14
14
proposed for addition here, though it may be decided that a few don't
@@ -19,16 +19,16 @@ to see who had made changes to the recipe in the past. Anyone who has
19
19
touched the recipe should be pinged about it, so that they can be added here. They
20
20
should also be consulted with regards, if the recipe needs any
21
21
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 take up the role as a maintainer the only they should be added in the maintainer list.
22
+ like to be added as maintainers. If they give their consent
23
+ to take up the role as a maintainer, only then they should be added in the maintainer list.
24
24
25
25
In all cases while porting a recipe, you should add yourself as a
26
26
maintainer. Some contributors to these repos might be quite prolific, but may
27
27
not be as actively engaged. If they specify they only want to be contacted
28
- for certain recipes or none at all, please respect their wishes add them too.
28
+ for certain recipes or none at all, please respect their wishes and add them too.
29
29
Make note of what recipes (if any) they would like to be notified for. If
30
30
they are no longer interested in any conda recipes, make that note here
31
- as well. Before contacting anyone please consult the list in this
31
+ as well. Before contacting anyone, please consult the list in this
32
32
`issue <https://github.com/conda-forge/staged-recipes/issues/139 >`__
33
33
to see if that contributor has restrictions.
34
34
@@ -38,9 +38,9 @@ The section order should go ``package``, ``source``, ``build``,
38
38
is recommended to add a ``build `` section with the ``number `` set to
39
39
``0 `` explicitly even if the rest is unneeded. If there is no build for
40
40
Windows, make sure to add ``skip: True # [win] `` to the ``build ``
41
- section. The ``about `` section must have the ``home `` URL (verify the
42
- URL is still correct), ``license `` (verify the correct license is present),
43
- and a one sentence (or few word ) ``summary ``. When specifying the version it
41
+ section. The ``about `` section must have the ``home `` URL (verify if the
42
+ URL is still correct), ``license `` (verify if the correct license is present),
43
+ and a one sentence (or few words ) ``summary ``. When specifying the version, it
44
44
is strongly recommended that jinja templating be used to set the version
45
45
at the top (e.g. ``{% set version = "0.10.1" %} ``) and then replace all
46
46
uses of the version with ``{{ version }} ``. Preference should be given to
@@ -49,15 +49,15 @@ all links to compressed source balls allow for easy changing of the version
49
49
(using latest is not acceptable). Also, a checksum should be included with
50
50
all compressed source balls to allow for verification of downloads.
51
51
52
- It is required to add tests with all packages. These can include but are
53
- not limited to checking libraries are installed, python imports, simple
52
+ It is required to add tests with all packages. These can include, but are
53
+ not limited to, checking if libraries are installed, python imports, simple
54
54
code snippet to compile or run a basic test, command line usage (checking
55
- help or version). It is suggested that compiled code run all tests (e.g.
55
+ help or version). It is suggested to get the compiled code to run all tests (e.g.
56
56
``make check ``) to ensure it was built properly. This normally should
57
57
happen in the build.
58
58
59
59
It is possible, though not recommended, to include multiple recipes into a
60
- single pull request on staged-recipes. conda-build-all is used to determine
60
+ single pull request on ` staged-recipes < https://github.com/conda-forge/staged-recipes >`__. `` conda-build-all `` is used to determine
61
61
the build order and the necessary build matrix (e.g. which python versions to
62
62
build against). From a practical perspective, there are limitations on the
63
63
continuous integration resources and also on what reviewers are able/willing
@@ -70,7 +70,7 @@ suitable order.
70
70
None of this is to say that one can't add multiple recipes in a single
71
71
pull request. One certainly can do this and it can work, but the
72
72
recommendation is to open a PR with one recipe first, and to ping
73
- @conda-forge/core to ask for agreement about adding one or two additional
73
+ ** @conda-forge/core ** to ask for agreement about adding one or two additional
74
74
recipes.
75
75
76
76
0 commit comments