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
On the devguide landing page, there's a section called 'Contributing', under which there is a section and links:
Beginner tasks to become familiar with the development process
Helping with Documentation
Increase Test Coverage
Clicking on 'Helping with Documentation' leads to the page of the same name and section 6.1 starts with:
6.1. Helping with issues filed on the issue tracker
If you look at documentation issues on the issue tracker, you will find various documentation problems that need work. Issues vary from typos, to unclear documentation, to something completely lacking documentation.
Within that text 'documentation issues' is also a link, leading to this page: current
When I first looked at the devguide last year to try to begin contributing, I found the results returned from that link very confusing. They are in priority sections with the oldest ones first. I didn't know if I was looking at the right thing because I wasn't familiar with the bug tracker and I didn't understand that there are some issues that can be 7+ years old. Anyway, I propose the following link to make it easier for new users to find documentation bugs to work on: suggested
Also, I think it might be helpful in that section to add a sentence to explain that some issues already have a pull request or patch that indicates that someone else is already working on the issue.
The text was updated successfully, but these errors were encountered:
Both of those suggestions make sense to me as well - the paperclip and octocat icons are handy, but thoroughly cryptic if nobody has told you what they mean :)
Thanks, I'll prepare a PR. FYI, I didn't realize it was octocat until you just mentioned it. It looked like headphones to me, which was completely confusing.
On the devguide landing page, there's a section called 'Contributing', under which there is a section and links:
Clicking on 'Helping with Documentation' leads to the page of the same name and section 6.1 starts with:
Within that text 'documentation issues' is also a link, leading to this page:
current
When I first looked at the devguide last year to try to begin contributing, I found the results returned from that link very confusing. They are in priority sections with the oldest ones first. I didn't know if I was looking at the right thing because I wasn't familiar with the bug tracker and I didn't understand that there are some issues that can be 7+ years old. Anyway, I propose the following link to make it easier for new users to find documentation bugs to work on:
suggested
Also, I think it might be helpful in that section to add a sentence to explain that some issues already have a pull request or patch that indicates that someone else is already working on the issue.
The text was updated successfully, but these errors were encountered: