conda-forge is a community-driven effort of cross-platform packaging and relies on volunteers to sustain and improve.
We encourage you to contribute to conda-forge. You can do so in several ways:
Improve the documentation¶
The conda-forge documentation is version-controlled in the conda-forge.github.io repository on GitHub. The source text is stored in the src/ subdirectory of this repository and is formatted using Python’s reStructuredText system.
Editing the documentation directly through Github¶
You can propose quick edits directly through the GitHub website if you have a GitHub account — for instance, this link will take you directly to a web-based editor for this very webpage. In general, the file corresponding to each page in the GitHub browser has a little pencil icon in its top-right corner that lets you open it up for editing.
Editing the documentation locally¶
We are glad to know that you would like to contribute to the conda-forge documentation. If you are new to the conda-forge community, follow the steps below to make your first contribution:
git clone https://github.com/<your-username>/conda-forge.github.io.git
Create a new branch deriving from
mainto do your work:
git checkout -b <new-branch-name>
Run the following commands:
conda env create -f ./.ci_scripts/environment.yml
conda activate conda-forge-docs
cd newsfeed && pip install --no-deps .
Make your changes and run the following command to check them:
You can check the changes locally by opening the html files in
python -m http.server --directory src/_build/html
Add and commit your changes:
git add .
git commit -m "your commit message"
Submit a pull request to the main repository proposing your changes.
Some basic writing guidelines should be kept in mind before you start contributing:
Identify your audience and understand their skill level.
Match the technical language with the audience’s skill level proficiency.
Try to keep it simple. In case you have to use a lot of complicated terms, provide a glossary of key terms.
Address the audience directly as the user(s).
While mentioning an action, use the “command” form of the verb: “Choose an option from the menu and press Enter.”
For references, provide links to related content.
Use headings and bullet points, which makes it easier to read.
Avoid ambiguous titles. The title should include a clear description of the page’s subject.
Check your spellings and grammar.
conda-forge should always be spelt in lowercase, hyphenated, and without backticks. It should only be backticked when used as an identifier (e.g. the Anaconda.org channel, the Github organization, etc).