Added http://learn.jquery.com/style-guide/ to http://contribute.jquery.o... #87
Conversation
|
This is a draft of the solution to issue #75 |
| @@ -8,6 +8,9 @@ Our style guides aim to make the code bases appear as if they were written by on | |||
|
|
|||
| Long term, we would like to have all of the formatting automatically done by the build process, so that the resulting code would always follow the style guide. We haven't reached that nirvana yet, but we have taken a few steps in that direction. For example, our projects contain an [EditorConfig file](http://editorconfig.org) that many programming editors can use to enforce the space and tab rules. Our [JSHint](http://www.jshint.com/about/) configuration checks for common style _faux pas_ such as trailing spaces on a line, or using a variable before it is defined. | |||
|
|
|||
|
|
|||
| ### [General Style Guide](/style-guide/prose/) | |||
|
Scott, could you tell me if anymore changes are needed, please? |
|
ping @scottgonzalez |
| @@ -0,0 +1,113 @@ | |||
| --- | |||
| title: Prose Style Guide | |||
| --- | |||
There was a problem hiding this comment.
@scottgonzalez Excuse me, what do you mean when you say that this should be "JSON"?
There was a problem hiding this comment.
Take a look at any of the other pages. They all use JSON instead of YAML.
<script>{
"title": "Prose Style Guide"
}</script>
|
|
||
| ## Writing Style | ||
|
|
||
| Content should be educational and accessible to a broad audience of developers. The primary target audience is beginning to intermediate jQuery users, with advanced jQuery users as a secondary audience. When creating content, please keep one of these audiences in mind as well as the following style guidelines: |
There was a problem hiding this comment.
This was written for the learn site and needs to be changed to apply to all documentation.
There was a problem hiding this comment.
@scottgonzalez Could you give some guidelines to start working on this, please?
|
@pablofiu Would you mind updating the PR and address the things mentioned above? Thanks! :) |
|
@arthurvr I will resume work in this PR tomorrow. I will keep updated of all you. |
|
I deleted my fork and unfortunately was not able to add more commits to this pull request. That is why I created a new one: #98 |
...rg/style-guide/prose/
This is a draft. Suggestions are welcome.