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: README.md
+34-4Lines changed: 34 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,11 +26,41 @@ If you have questions or need help, please check out our documentation for a [li
26
26
4. Make and commit your changes.
27
27
5. Submit a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) to the main repository proposing your changes.
28
28
29
+
## Code of conduct
30
+
31
+
We at conda-forge adhere to the [NumFOCUS Code of Conduct](https://numfocus.org/code-of-conduct):
32
+
33
+
> * Be kind to others. Do not insult or put down others. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate for conda-forge.
34
+
>
35
+
> * All communication should be appropriate for a professional audience, including people of many different backgrounds. Sexual language and imagery is not appropriate.
36
+
>
37
+
> * conda-forge is dedicated to providing a harassment-free community for everyone, regardless of gender, sexual orientation, gender identity and expression, disability, physical appearance, body size, race, or religion. We do not tolerate harassment of community members in any form.
38
+
39
+
Thank you for helping make this a welcoming, friendly community for all.
40
+
41
+
### Reporting guidelines
42
+
43
+
If you believe someone is violating the code of conduct, please report this in a timely manner. Code of conduct violations reduce the value of the community for everyone. The team at conda-forge takes reports of misconduct very seriously and is committed to preserving and maintaining the welcoming nature of our community.
44
+
45
+
All reports will be kept confidential. Please have a look at the [Reporting guidelines](https://numfocus.org/code-of-conduct#reporting-guidelines).
46
+
47
+
### Enforcement: What happens after a report is filed?
48
+
49
+
conda-forge's team and/or our event staff will try to ensure your safety and help with any immediate needs, particularly at an in-person event. Once we have received the report through the relevant authorities, conda-forge will make every effort to acknowledge the receipt and take action. Have a look at the process of [What Happens After a Report is Filed?](https://numfocus.org/code-of-conduct#enforcement).
50
+
29
51
## conda-forge dev meetings
30
52
31
-
Our documentation contains a section with [minutes from previous dev meetings]([https://conda-forge.org/docs/minutes/00_intro.html]). These meetings occur every two weeks on Wednesday from 17:00-18:00 UTC.
32
-
A link to the google calendar item can be found [here](https://calendar.google.com/event?action=TEMPLATE&tmeid=bTk5ZzBoMDEzaW11cmZiNWJnNmNkbThocDRfMjAyMjA1MThUMTcwMDAwWiBlcmljQHZvbHRyb25kYXRhLmNvbQ&tmsrc=eric%40voltrondata.com&scp=ALL).
53
+
We hold biweekly meetings every second Wednesday from 17:00-18:00 (UTC). Feel free to stop by!
54
+
Up-to-date invites are always available in the [conda.org community calendar](https://conda.org/community/calendar). Look for the `[conda-forge] core meeting` events!
55
+
56
+
Our [meeting notes](https://conda-forge.org/docs/orga/minutes/00_intro.html) record important points discussed during the meetings and serve as a record for upcoming meetings. We make use of [HackMd](https://hackmd.io/) and a [template](https://github.com/conda-forge/conda-forge.github.io/blob/main/misc/DEV_MEETING_TEMPLATE.md) to create the meeting notes.
57
+
58
+
We use a Github Actions [workflow][gha-workflow] to create an automated PR with the meeting notes
59
+
template for each session, which is automatically published to our HackMD team account. During the
60
+
meeting, attendees will edit the HackMD document. After the meeting, the document is saved and the
61
+
PR is synced with the changes by adding the `sync-hackmd-notes` label. Once satisfied, the PR is
62
+
merged and the website will be updated with the new meeting notes.
33
63
34
-
We use https://hackmd.io/ for taking meeting minutes and will (eventually) upload the resultant markdown file after the meeting has concluded.
64
+
We encourage contributors to join the meetings and learn more about and from the community.
35
65
36
-
There is a template provided in [`misc/DEV_MEETING_TEMPLATE.md`](https://github.com/conda-forge/conda-forge.github.io/tree/main/misc/DEV_MEETING_TEMPLATE.md) that you should use to create a new hackmd document.
Copy file name to clipboardExpand all lines: src/contracting/00_intro.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
Contracting Information
2
2
#######################
3
3
4
-
If you are interested in a contractual engagement to solve a specific problem that you're facing, this page details the kinds of services that are available to you. Conda-forge, as an entity, does not have the ability to engage in a contractual arrangement as of now.
4
+
If you are interested in a contractual engagement to solve a specific problem that you're facing, this page details the kinds of services that are available to you. conda-forge, as an entity, does not have the ability to engage in a contractual arrangement as of now.
5
5
However, there are a number of community members that you may engage with.
6
-
Conda-forge does not endorse anyone (individuals or companies) listed on this page.
6
+
conda-forge does not endorse anyone (individuals or companies) listed on this page.
7
7
8
8
9
9
If you are interested in a service that is not listed on this page, please reach out to us on our `issue tracker <https://github.com/conda-forge/conda-forge.github.io/issues>`__, on `Element <https://app.element.io/#/room/#conda-forge:matrix.org>`__ or via emailing the core team directly at [email protected] and we will help to circulate your request more broadly within the community.
Copy file name to clipboardExpand all lines: src/index.rst
+8-1Lines changed: 8 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@ conda-forge documentation
3
3
4
4
What is conda-forge?
5
5
--------------------
6
+
6
7
conda-forge is a community effort and a GitHub organization which contains repositories of conda recipes and thus provides conda packages for a wide range of software.
7
8
The built distributions are uploaded to `anaconda.org/conda-forge <https://anaconda.org/conda-forge>`__ and can be installed with `conda <https://conda.pydata.org/docs/intro.html>`_.
8
9
@@ -12,7 +13,13 @@ Chances are we have already packaged it for you. You can `search <https://anacon
12
13
13
14
**Cannot find a package or only outdated versions of a package?** - Everybody is welcome to contribute to our package stack!
14
15
15
-
- To get started contributing packages, see :ref:`becoming_involved`.
16
+
- We value all kinds of contributions — not just code. A few recommended ways to start contributing to conda-forge are:
17
+
18
+
- `Contribute new packages <https://conda-forge.org/docs/maintainer/adding_pkgs.html>`__
19
+
- Help update and `maintain packages <https://conda-forge.org/docs/maintainer/updating_pkgs.html#maintaining-pkgs>`__
20
+
- Suggest or implement improvements for our `infrastructure <https://conda-forge.org/docs/maintainer/infrastructure.html#infrastructure>`__
21
+
- Help `improve the documentation <https://conda-forge.org/docs/user/contributing.html#improve-docs>`__
22
+
- For a detailed overview please refer to :ref:`becoming_involved`.
16
23
17
24
- To see our governance policies, see `here <https://conda-forge.org/docs/orga/governance.html>`_.
Copy file name to clipboardExpand all lines: src/maintainer/adding_pkgs.rst
+23-8Lines changed: 23 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,22 @@
3
3
Contributing packages
4
4
*********************
5
5
6
-
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.
6
+
The contribution process can be broken down into three steps:
7
7
8
-
The sections below provide detailed instructions on contributing packages to conda-forge.
8
+
* Step 1. Staging process (add recipe and license).
9
9
10
+
With the help of :ref:`the staging process <creating_recipes>`, add a package's recipe and license to the `staged-recipes repository <https://github.com/conda-forge/staged-recipes>`__ and create a PR.
11
+
12
+
* Step 2. Post staging process.
13
+
14
+
Once your PR, has been merged, take a look at our :ref:`post_staging_process` to know what follows.
15
+
16
+
* Step 3. Maintaining the package.
17
+
18
+
Contributing a package to ``conda-forge`` makes you the maintainer of that package.
19
+
Learn more about the :ref:`roles of a maintainer <maintainer_role>`.
20
+
21
+
The sections below will add more details about each step.
10
22
11
23
.. _creating_recipes:
12
24
@@ -115,9 +127,10 @@ After merging the :term:`PR`, our :term:`CI` infrastructure will build the packa
115
127
116
128
If you have questions or have not heard back for a while, you can notify us by including ``@conda-forge/staged-recipes`` in your GitHub message.
117
129
130
+
.. _post_staging_process:
118
131
119
132
Post staging process
120
-
--------------------
133
+
====================
121
134
122
135
* After the PR is merged, our :term:`CI` services will create a new git repo automatically. For example, the recipe for a package named ``pydstool`` will be moved to a new repository `https://github.com/conda-forge/pydstool-feedstock <https://github.com/conda-forge/pydstool-feedstock>`_. This process is automated through a CI job on the ``conda-forge/staged-recipes`` repo. It sometimes fails due to API rate limits and will automatically retry itself. If your feedstock has not been created after a day or so, please get in touch with the ``conda-forge/core`` team for help.
123
136
* CI services will be enabled automatically and a build will be triggered automatically which will build the conda package and upload to `https://anaconda.org/conda-forge <https://anaconda.org/conda-forge>`_
@@ -153,10 +166,12 @@ These are the CI configuration files for service providers like Azure and Travis
153
166
conda-forge.yml
154
167
................
155
168
156
-
This file is used to configure how the feedstock is set up and built. Making any changes in this file usually requires `rerendering the feedstock <https://conda-forge.org/docs/maintainer/updating_pkgs.html#dev-update-rerender>`__.
169
+
This file is used to configure how the feedstock is set up and built. Making any changes in this file usually requires :ref:`dev_update_rerender`.
170
+
171
+
.. _maintainer_role:
157
172
158
173
Maintainer role
159
-
---------------
174
+
===============
160
175
161
176
The maintainer's job is to:
162
177
@@ -180,7 +195,7 @@ the other packages being added as a requirement), the build script will be able
180
195
locate the dependencies that are only present within staged-recipes as long as
181
196
the builds finish in the dependencies order. Using a single pull request
182
197
allows you to quickly get packages set up without waiting for each package in a
183
-
dependency chain to be reviewed, built, and added to the conda-forge channel
198
+
dependency chain to be reviewed, built, and added to the ``conda-forge`` channel
184
199
before starting the process over with the next recipe in the chain.
185
200
186
201
.. note::
@@ -841,12 +856,12 @@ Recipe Maintainer
841
856
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.
842
857
843
858
Contributing a recipe for package makes you the ``maintainer`` of that package automatically.
844
-
See `Maintainers Role <https://conda-forge.org/docs/maintainer/adding_pkgs.html#maintainer-role>`__ and `Maintaining Packages <https://conda-forge.org/docs/maintainer/updating_pkgs.html#maintaining-packages>`__ to learn more about what are the things that maintainers do.
859
+
See :ref:`maintainer_role` and :ref:`maintaining_pkgs` to learn more about what are the things that maintainers do.
845
860
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:
846
861
847
862
``@conda-forge-admin, please add user @username``
848
863
849
-
where username is the GitHub username of the new maintainer to be added. Please refer to `Becoming a maintainer <https://conda-forge.org/docs/orga/guidelines.html#becoming-a-maintainer>`__ and `Updating the maintainer <https://conda-forge.org/docs/maintainer/updating_pkgs.html#updating-the-maintainer-list>`__ for detailed instructions.
864
+
where username is the GitHub username of the new maintainer to be added. Please refer to :ref:`becoming_a_maintainer` and :ref:`maint_updating_maintainers` for detailed instructions.
Copy file name to clipboardExpand all lines: src/maintainer/infrastructure.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Smithy contains maintenance code for conda-forge, which is used by the ``conda-s
25
25
26
26
``conda-smithy`` also contains the command line tool that you should use if you rerender manually from the command line (see :ref:`dev_update_rerender`).
27
27
28
-
Smithy can be used beyond Conda-Forge's purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-Conda-Forge infrastructures.
28
+
Smithy can be used beyond conda-forge's purposes. For example, it can be used to `set up self-hosted Azure agents <azure-config>` for non-conda-forge infrastructures.
29
29
(You could also consider using `Azure virtual machine scale set agents <https://docs.microsoft.com/en-us/azure/devops/pipelines/agents/scale-set-agents?view=azure-devops>`_,
30
30
which could be less expensive to run than permanently active agents.)
31
31
@@ -63,7 +63,7 @@ If you found any typo error, unclear explanations or new topics that can be cove
63
63
Admin web services
64
64
==================
65
65
66
-
Conda-forge is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
66
+
conda-forge is running a webservice on Heroku called `conda-forge-webservices <https://github.com/conda-forge/conda-forge-webservices>`_.
67
67
68
68
The following services are run by default on a feedstock:
69
69
@@ -279,7 +279,7 @@ take more serious actions, including archiving feedstocks or removing maintainer
279
279
Compilers and Runtimes
280
280
======================
281
281
282
-
Conda-forge builds and maintains its own set of compilers for various languages
282
+
conda-forge builds and maintains its own set of compilers for various languages
283
283
and/or systems (e.g., ``C``, ``FORTRAN``, ``C++``, ``CUDA``, etc.). These are used
284
284
in all of our CI builds to build both core dependencies (e.g., ``Python``) and maintainer-contributed
285
285
packages. While we do not have any formal policies or promises of support for these
0 commit comments