Contributing to conda#

Thank you for your interest in improving conda! Below, we describe how our development process works and how you can be a part of it.

Already know how to contribute and need help setting up your development environment? Read the development environment guide here

Hosted on GitHub#

All development currently takes place on [GitHub][github]. This means we make extensive use of the project management tools they provide such as issues and projects.

Code of Conduct#

When you decide to contribute to this project, it is important to adhere to our code of conduct, which is currently the NumFOCUS Code of Conduct. Please read it carefully.

Conda Contributor License Agreement#

To begin contributing to this repository, you need to sign the Conda Contributor License Agreement (CLA). In case you’re new to CLAs, this is a rather standard procedure for larger projects. Django and Python for example both use similar agreements.

[Click here to sign the Conda Contributor License Agreement][conda cla].

A record of prior signatories is kept in a [separate repo in conda’s GitHub][clabot] organization.

Ways to contribute#

Below are all the ways you can get involved in with conda.

Bug reports and feature requests#

Bug reports and feature requests are always welcome. To file a new issue, head to the issue form.

It should be noted that conda-build issues need to be filed separately at its issue tracker.

For all other types of issues, please head to [Anaconda.org’s “Report a Bug” page][anaconda-bug-report]. For even more information and documentation on everything related to Anaconda, head to the [Support Center at Anaconda Nucleus][anaconda-support].

Before submitting an issue via any of these channels, make sure to document it as well as possible and follow the submission guidelines (this makes everyone’s job a lot easier!).

Contributing your changes to conda#

Here are steps you need to take to contribute to conda:

  1. [Signup for a GitHub account][github signup] (if you haven’t already) and [install Git on your system][install git].

  2. Sign the [Conda Contributor License Agreement][conda cla].

  3. Fork the conda repository to your personal GitHub account by clicking the “Fork” button on conda/conda and follow GitHub’s instructions.

  4. Work on your proposed solution. Visit this page if you need help getting your development environment setup

  5. When you are ready to submit a change, create a pull request.

Your first contribution#

For your first contribution, we recommend:

  • Look for issues labeled with good first issue

  • Start with small changes like documentation or minor bug fixes

  • Read through existing code to understand the project structure and our patterns

  • Asking questions if you need help, see the getting help section below.

Change process#

In order to maintain proper tracking and visibility, make sure that there are issues for adding features, fixing bugs, and major refactoring work. When creating a new issue, make sure to use the issue template.

When making a change, try to scope changes to what can be accomplished in less than a day of work with minimal code changes to facilitate rapid code reviews—typically fewer than 200 lines of code.

Create a new local branch for each change. Keep your changes focused on a single issue to make reviews easier.

Pull Requests#

Pre-submission Steps#

  1. Install and run pre-commit hooks

  2. Make sure all tests are passing

  3. Rebase changes on main if other changes were merged during development

  4. Use the Pull Request template if one exists for the project

  5. Self-review your code with fresh eyes before requesting external review

  6. Draft pull requests are acceptable for early feedback

The Pull Request title should clearly explain the contents of the change. Like the first line of a commit message, it should be a maximum of 50 characters, written in an imperative mood, and have no ending period.

Review requirements#

Most code changes require one reviewer from the conda-maintainers team. When you submit a Pull Request, that group will automatically be assigned as the reviewer.

What to expect during code review#

The primary goal of code review is to ensure maintainability of integrated code. Reviews will focus on:

  • Code correctness and logic

  • Maintainability and readability

  • Consistency with project patterns and practices

Reviews will NOT focus on:

  • Code formatting (handled by pre-commit hooks)

  • Minor style preferences

  • Test coverage and performance (measured by CI)

If you receive feedback, don’t worry! Code review is a collaborative process to make the code as good as possible. Address the feedback and feel free to ask questions if anything is unclear.

Conda capitalization standards#

  1. Conda should be written in lowercase, whether in reference to the tool, ecosystem, packages, or organization.

  2. References to the conda command should use code formatting (i.e. conda).

  3. If the use of conda is not a command and if conda is at the beginning of a sentence, conda should be uppercase.

Examples#

In sentences#

Beginning a sentence:

  • Conda is an open-source package and environment management system.

  • conda install can be used to install packages.

Conda in the middle of a sentence:

  • If a newer version of conda is available, you can use conda update conda to update to that version.

  • You can find conda packages within conda channels. The conda command can search these channels.

In titles and headers#

Titles and headers should use the same capitalization and formatting standards as sentences.

Getting help#

If you need help with your contribution:

We’re here to help and appreciate your contribution!