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

Update the Build Procedure in README.md

Đang mở
#1,305 9 bình luận 0 reaction 2 người được giao Được @prachinandi nhận Xem trên GitHub
Docs Outreachy
Ngôn ngữ chính
JavaScript
Star
170
Fork
320
Merge trung bình
2 ngày 10 giờ
Pull request đã merge (30 ngày)
5

Mô tả

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)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.