Create Prose Style Guide

[jquery]

Create Prose Style Guide

[marti1125]

Hi @scottgonzalez, how to can I contribute on this?

[scottgonzalez]

To start, you should read through http://contribute.jquery.org/ and http://learn.jquery.com/style-guide/. Then you could send a PR with a first draft.

[marti1125]

(everything from READMEs to API documentation to articles and tutorials) I am new, where are READMEs =? could you give me the links?

[scottgonzalez]

READMEs are in all of the various repositories. To be honest, a large part of this task requires the knowledge of someone immersed in this community.

[marti1125]

@scottgonzalez well I will try with this https://github.com/jquery/sizzle it is ok?

[kswedberg]

@marti1125 You might want to start with the one at https://github.com/jquery/api.jquery.com/blob/master/README.md

Let me know if you have any questions about it.

[pablofiumara]

I need some confirmation.

Do you wish to have the information in http://learn.jquery.com/style-guide/ distributed inside pages at http://contribute.jquery.org/ ?

[scottgonzalez]

The style guide needs to move out of the various locations that it currently exists, including http://learn.jquery.com/style-guide/, and into http://contribute.jquery.org/style-guide/prose/.

[pablofiumara]

Thanks for your answer.

I will send you a pull request with a first draft in the next few days.

[scottgonzalez]

@pablofiu That's great. If you have any questions, just ask here or in #jquery-content on IRC.

[pablofiumara]

Thank you, Scott.

[pablofiumara]

I have just sent you a pull request #87 There, you will see a draft of the solution to issue #75

[scottgonzalez]

See jquery/learn.jquery.com#285 for more details.

[agcolom]

With regards to code output placement, we agreed to use
// >
on its own line. We might then choose to replace this with whatever we decide is more suitable on build (e.g. ➡ or → or something else) otherwise, keep >, see globalizejs/globalize#313

[arthurvr]

Slightly related: Markdown "code" style is something else I'd like to document one day. Do we want new lines under headings, hard wrapping, how do we make lists, ...

[agcolom]

Adding a note here regarding the use of instead of " " in the api docs where appropriate. (From today's content meeting)

[jzaefferer]

Recommendations for README content: https://the-pastry-box-project.net/charlotte-spencer/2015-september-16

Some tools that we might be able to integrate:

• http://www.hemingwayapp.com/ - Editor hat helps write short and simple english
• http://alexjs.com/ - Catch insensitive, inconsiderate writing
• http://joblint.org/ - Test tech job posts for issues with sexism, culture, expectations, and recruiter fails.