Conversation
JackStouffer
commented
Nov 25, 2015
JackStouffer
commented
- Added a FAQ section to answer some common questions from people have about their PRs. This was inspired about by Tuple's toString made useful #3594, where a lot of good work was almost lost.
- fixed the links to be in a list rather than headers
|
✅ |
|
I think this should be on the wiki, since it applies to all projects. |
|
Ok, but I think it should be in here as well, because I think more people read |
|
Then it should link to the wiki. DRY. |
|
To clarify... We seem to have a plethora of contribution guides. Everyone seems to want to write a contribution guide, because it's going to be better than all the other ones or something. As a result we have an uncoordinated duplication of information and effort. This can lead to situations such as "OK, how did you manage to create this git/PR/etc. abomination?" "I followed the guide." "Which guide?" "The one on the D website." ... First, there's the wiki pages which are already linked to from this file: http://wiki.dlang.org/Starting_as_a_Contributor More D Wiki pages: http://wiki.dlang.org/Get_involved ...and other pages on http://wiki.dlang.org/Category:Contribution_Guidelines. Then, there's the projects' .md files: https://github.com/D-Programming-Language/druntime/blob/master/HACKING.md If anything, we need to turn the valve in the other direction, and work on consolidation and quality, not quantity. |
|
Well, I just created this page http://wiki.dlang.org/Contributing_FAQ and linked it in the file |
|
No, as I wrote on the talk page please do not create any more pages. Add the information to one of the many existing pages instead. |
|
I'll add it to the "Starting as a Contributor" page, butI don't have permission to delete pages. |
|
Can you integrate any useful information into http://wiki.dlang.org/Pull_Requests ? It already covers the topic of rebasing. |
|
@CyberShadow I'd rather not write a tutorial on squashing or updating with rebase as I think the tutorials I link do a better job than I could of explaining things. |
|
Are those tutorials significantly better than the information we have on the wiki? We should avoid relying on 3rd-party resources anyway, as they're not updatable and subject to bitrot. |
|
Updated link
Yes, there is nothing that I see in "Pull Requests" that explains squashing and I think the tutorial for rebasing does a much better job of explaining rebasing for updating PRs. |
|
OK, then how about adding the links to http://wiki.dlang.org/Pull_Requests? |
|
Why don't I just take this opportunity to merge http://wiki.dlang.org/Starting_as_a_Contributor into |
|
That would be great if you want to undertake such a project. (But of course, only if the result is not less informative than its parts.) |
|
Sure. Can you delete http://wiki.dlang.org/Contributing_FAQ |
|
Done. |
|
@CyberShadow I think I've successfully done it http://wiki.dlang.org/Starting_as_a_Contributor |
|
Haven't reviewed it but good work 👍 You can change the other pages to be redirects to relevant sections to this one, then fix links to the olde pages. |
JackStouffer
changed the title
|
Updated changes to CONTRIBUTING.md |
|
And another page that needs merging: http://wiki.dlang.org/Using_Git_on_Windows |
|
I will fix the redirects and merge the other article, but I believe this can be merged regardless. |
|
Can we get rid of the single-item-list? Maybe integrate the link into the above paragraph, e.g. "To get started, please read the Starting as a Contributor article on the D wiki." |
|
Fixed |
Seems the new page is less informative than its parts. For example, there is no mention of Digger or the other build tools. |
|
Auto-merge toggled on |
|
Added the existing tools section onto the page. |
Thanks |
Can you please make sure that nothing else was missed? |
3 participants
