You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/maintainer/adding_pkgs.rst
+21-15Lines changed: 21 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,26 +18,31 @@ The sections below provide detailed instructions on contributing packages to con
18
18
The staging process
19
19
===================
20
20
21
-
Getting Started
22
-
---------------
21
+
The staging process i.e adding a package's recipe has three steps:
22
+
23
+
#. Generating the recipe
24
+
#. Checklist
25
+
#. Feedback and revision
23
26
24
-
There are multiple ways to get started:
27
+
Generating the recipe
28
+
---------------------
29
+
30
+
There are, currently, three ways to generate a recipe:
25
31
26
-
#. Look at `the example recipe <https://github.com/conda-forge/staged-recipes/tree/master/recipes/example>`_ in the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`_ and modify it as necessary.
27
32
#. If it is an R package from `CRAN <https://cran.r-project.org/>`_, kindly
28
33
start by using the `conda-forge helper script for R recipes <https://github.com/bgruening/conda_r_skeleton_helper>`_ instead.
29
34
Then if necessary, you can make manual edits to the recipe.
30
35
#. If it is a python package, you can generate the recipe as a starting point with ``grayskull``.
31
36
Use ``conda install -c conda-forge grayskull`` to install ``grayskull``, followed by ``grayskull pypi your_package_name`` to generate the recipe. Note that you do *not* necessarily have to use ``grayskull``, and the
32
37
recipes produced by ``grayskull`` might need to be reviewed and edited. Read more about ``grayskull`` and how to use it `here <https://github.com/conda-incubator/grayskull#introduction>`__.
38
+
#. If it's none of the above, generate a recipe with the help of `the example recipe <https://github.com/conda-forge/staged-recipes/tree/master/recipes/example>`_ in the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`_ and modify it as necessary.
33
39
34
40
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.
35
41
36
42
.. note::
37
43
38
44
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
45
40
-
41
46
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.
42
47
43
48
.. _staging_steps:
@@ -49,17 +54,18 @@ Step-by-step Instructions
49
54
should be downloadable as an archive (.tar.gz, .zip, .tar.bz2, .tar.xz)
50
55
or tagged on GitHub, to ensure that it can be verified. (For further
0 commit comments