[MRG] [DOC] Put "Filing bugs" subsection under "Submitting bug report" section. #10917
Conversation
doc/developers/contributing.rst
Outdated
| @@ -42,6 +42,46 @@ ticket to the | |||
| `Bug Tracker <https://github.com/scikit-learn/scikit-learn/issues>`_. You are | |||
| also welcome to post feature requests or pull requests. | |||
|
|
|||
| .. _filing_bugs: | |||
|
|
|||
| Filing Bugs | |||
There was a problem hiding this comment.
It feels like there is no real-need for a subsection here. The few lines above can be merged in the same section.
Maybe "Submitting a bug report" is a bit better as a title, but not very important. Do keep the same reference name otherwise, some links somewhere in the world will break (OK not really break but not find any anchor to go to in the page).
|
@lesteve I was afraid of breaking references, that's why I kept both section and subsection titles. However, having had a second look, I think changing Filing bugs to a question, like How to report bugs can make both section and subsection relevant, where the small paragraph before the subsection would serve as an introduction. |
|
Fair point, so maybe this section should be something along these lines (mostly reusing the existing content): Submitting a bug report of feature request
How to make a good bug report (title can be improved)
|
|
@lesteve Let me know what you think about the last edit. I tried to incorporate what you suggested. |
|
Maybe |
|
I pushed some tweaks, mostly reorganising the content slightly add adding bold to emphasize the important bits. @mohamed-ali and @qinhanmin2014 can you have a quick look? |
|
In general I think the contributing doc could be reorganised further but I would be in favour of merging this PR as is (and possibly continue the work in other PRs). This PR is already a good improvement as I feel we can refer people to this when we want additional information (snippet, versions, formatting improvements, etc ...). |
|
Just as @lesteve points out, I think contributing.html can be further reorganised into several parts: Ways to contribute at the beginning, following with guidance to submit issue, submit PR, review PR, etc. |
Reference Issues/PRs
--
What does this implement/fix? Explain your changes.
It makes more sense to put Filing bugs subsection under section Submitting bug report instead of section Contributing code
Any other comments?
This will help to resolve issue #10892.