[
https://issues.apache.org/jira/browse/CB-10448?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15128132#comment-15128132
]
Dmitry Blotsky commented on CB-10448:
-------------------------------------
I think "constant, on-going vigilance" is an unfortunately impractical ask of a
loosely-tied team of committers. If we are to adopt any style rules at all, the
best (and only practical) avenue in my opinion would be to use an automated
tool that produces high-quality actionable errors. For our source code, we use
source code linters. I imagine that there are plain text linters out there that
we can use for our docs. This warrants investigation and proof-of-concept
implementation on a few repos in order for adoption among any of us. Did you
have a proposal in mind for how to proceed with this? If so, please submit it
to https://github.com/cordova/cordova-discuss using the instructions in that
repository.
As for the styleguide, could you please submit it as a Pull Request on GitHub?
> Cordova should have a styleguide
> --------------------------------
>
> Key: CB-10448
> URL: https://issues.apache.org/jira/browse/CB-10448
> Project: Apache Cordova
> Issue Type: Task
> Components: Docs
> Reporter: Dmitry Blotsky
> Attachments: Document Style Standards.HTML, docs-STYLEGUIDERP2.md
>
> Original Estimate: 48h
> Remaining Estimate: 48h
>
> Languages it should cover:
> - JavaScript
> - Markdown
> - Java
> - Objective C
> - C#
> - JSON
> - YAML
> - CSS
> - HTML
> - English (voice, tense, etc.)
> The existing docs styleguide
> (https://github.com/MSOpenTech/cordova-docs/tree/master/doc) is a good
> starting point. Having /docs/styleguide/LANGUAGE.md is a potential way to
> organise it.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
