/ceps

Conda Enhancement Proposals

Primary LanguagePythonCreative Commons Zero v1.0 UniversalCC0-1.0

Conda Enhancement Proposals

Conda is an Open Source project with a diverse and wide-ranging ecosystem.

To better allow community members to provide feedback and proposals for conda's implementation, all major changes should be submitted as Conda Enhancement Proposals (CEP).

References

These proposals are similar to conda-forge's CFEP, Python's PEP and IPython's IPEP processes etc.

Writing a new CEP

Community members are encouraged to author a CEP to suggest changes before any code is written to allow for the community to discuss the proposed changes.

The formal process by which CEPs should be authored and how they are reviewed and resolved is specified in CEP 1.

A template for new CEPs is given in CEP 0.

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 formmating standards as sentences.

In links

Links should use the same capitalization conventions as sentences. Because the conda docs currently use re-structured text (RST) as a markup language, and RST does not support nested inline markup, documentation writers should avoid using code backtick formatting inside links.