conda-forge / conda-forge/conda-forge.github.io

Update the Build Procedure in README.md

Open
#1,305 9 comments 0 reactions 2 assignees Claimed by @prachinandi View on GitHub
Docs Outreachy
Dominant language
JavaScript
Stars
170
Forks
320
Avg merge
2d 10h
Merged PRs (30d)
5

Description

As a first time contributor to the Conda-forge, the contributor would be reading the ``Build Procedure`` in ``Readme.md file,`` at first. Hence the steps that are to be taken to set the project in the local environment as well as ``to do lists`` before sending the PR should be mentioned clearly.

clear steps/tutorial links can be provided to let the contributor know how to get familiar with ``sphinx``. For example:
[sphinx Docs](https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)

This can be followed by steps mentioned above. In addition before sending PR the contributor should check the changes made in src folder works well by verifying the docs file in their local directory.

(open command prompt=> ``sphinx-build . ../docs`` =>auto generated html file in docs folder can be found)

These steps are not mentioned below:

![Screenshot (88)](https://user-images.githubusercontent.com/72700861/113296371-ff7edd80-9316-11eb-8a03-34d20c6633b6.png)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.