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

Update the Build Procedure in README.md

未关闭
#1,305 9 条评论 0 个 reaction 已指派 2 人 已被 @prachinandi 认领 在 GitHub 查看
Docs Outreachy
主要语言
JavaScript
星标
170
派生
320
平均合并
2 天 10 小时
30 天内合并 PR
5

描述

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)

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。