You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is your feature request related to a problem? Please describe.
Upon trying to start contributing to librosa to make improvements for the documentation, I encountered a few problems. The first is CONTRIBUTING.md is not accessible via the website, and I had to look through the repository to find it. The second is that the file for Compiling Documentation is not referenced in the Contributing Page. The documentation is unfortunately a bit scattered which makes it difficult for first-time contributors 😞
Describe the solution you'd like
This was talked about in an issue #1478 (comment). To summarize:
Find a way to auto-include the CONTRIBUTING.md page within the website
Describe alternatives you've considered
For the CONTRIBUTING.md page, it was proposed to link it or convert it into .rst. However, it is required for it to stay as an .md file to fit GitHub's Community Guidelines.
Is your feature request related to a problem? Please describe.
Upon trying to start contributing to
librosa
to make improvements for the documentation, I encountered a few problems. The first isCONTRIBUTING.md
is not accessible via the website, and I had to look through the repository to find it. The second is that the file for Compiling Documentation is not referenced in the Contributing Page. The documentation is unfortunately a bit scattered which makes it difficult for first-time contributors 😞Describe the solution you'd like
This was talked about in an issue #1478 (comment). To summarize:
CONTRIBUTING.md
page within the websiteDescribe alternatives you've considered
For the
CONTRIBUTING.md
page, it was proposed to link it or convert it into.rst
. However, it is required for it to stay as an.md
file to fit GitHub's Community Guidelines.Additional context
Please see #1478 (comment) and #1478 (comment) for further context 😸
The text was updated successfully, but these errors were encountered: