1375800 - [doc] add tips to create a patch in making-prs.md

Status: RESOLVED FIXED

(DevTools :: General, enhancement, P3)

Description

[Julian Descottes [:jdescottes]]

The current doc for making-prs.md mentions that patches should be attached to bugzilla without any indication on how to generate such patches.

It also contains a section about using a `gist` command which doesn't seem to work anymore.

Comment 1

[Julian Descottes [:jdescottes]]

Attachment: Bug 1375800 - [doc] add tips to create a patch file in devtools docs;

Review commit: https://reviewboard.mozilla.org/r/152128/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/152128/

Comment 2

[Julian Descottes [:jdescottes]]

:sole, let me know if you want me to mention something different for Git. Ideally I would like this to simply be about a few easy steps to have a patch ready, for first time contributors.

I removed the Gist section from the doc because it didn't work for me when trying locally and it's not clear how it's useful for our workflow anyway.

Comment 3

[Soledad Penades [:sole] [:spenades]]

Comment on attachment 8880759 [details]
Bug 1375800 - [doc] add tips to create a patch file in devtools docs;

https://reviewboard.mozilla.org/r/152128/#review157182

Ah that's great! thank you for spotting this and fixing it!

Two suggestions - they can be follow up:

1) use "Creating" instead of "Crafting", which sounds like you're an artisan and doesn't really add anything, but confuse readers (is "Creating" different from "crafting"? and how? etc)
2) I actually think the instructions in https://developer.mozilla.org/en-US/docs/Tools/Contributing#Creating_a_patch_to_check_in should be in this wiki, perhaps you can file a bug to migrate them here? They overlap with our contributing doc, and the most interesting part is the git patch bit, and sending attachments when you do not have commit access. This lowers the barrier of entry...

Comment 4

[Julian Descottes [:jdescottes]]

Comment on attachment 8880759 [details]
Bug 1375800 - [doc] add tips to create a patch file in devtools docs;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/152128/diff/1-2/

Comment 5

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/aa2f5375836a
[doc] add tips to create a patch file in devtools docs;r=sole

Comment 6

[Julian Descottes [:jdescottes]]

Thanks for the review, Sole!
- updated crafting to creating 
- logged Bug 1375850 to migrate the MDN contributing page to our docs

Comment 7

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/aa2f5375836a