Scope of this project & style guide debates
See original GitHub issueConsider #80. Even though the issue is closed there are some points the disposition and approach to that issue raise:
- The aim of this project (
gts
) seems to be to enable the Google style guide for anyone (Google, non-Google) who wants to use it. - However, it is not the right venue to debate the style guide itself. We are basically mirroring what Google uses internally and cannot (should not) editorialize the style itself.
- This means that this repo isn’t the best venue to debate the style guide.
- The style guide document itself isn’t public (yet). This makes it hard for users to understand the context and rationale behind the style rules.
The question becomes, how do we deal with critiques of the style guide:
- ‘This is not the correct venue for debates on the style guide’. This is unfulfilling for external users.
- Try to proxy concerns between internal and external venues. Somewhat better but still unfulfilling.
- Over the longer term, make this repo host the externalized style guide & make this authoritative?
@JustinBeckwith @mprobst: Thoughts?
Issue Analytics
- State:
- Created 6 years ago
- Comments:5 (2 by maintainers)
Top Results From Across the Web
The "Project" vs. "Not a Project" debate! On occasion, it may ...
The development of software for an improved business process, the construction of a building or bridge, the relief effort after a natural ...
Read more >Organizing and Producing Debates: An International Guide
2 | Organizing and Producing Candidate Debates: An International Guide. The National Democratic Institute (NDI) is a nonprofit, nonpartisan, ...
Read more >a guide to hosting local debates and forums
S., the sponsoring organization since 1988 has been the non- partisan Commission on Presidential Debates (www.debates.org). Your local debate or forum can be ......
Read more >OECD STYLE GUIDE
Please also refer to the PAC Publishing Guidelines available on http://oe.cd/ pubguidelines. Page 5. oecd style guide - third edition @oecd 2015. 4....
Read more >Keep Calm in Heated Debates: How People Perceive ...
Participants watching a video of a scientific debate evaluated a scientist using an aggressive discourse style as less credible, less competent, ...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
As a user of gts and a non-Google employee, I would greatly appreciate the ability to browse your official TypeScript style guide on https://google.github.io/styleguide/
Great discussion topic. I’m already running into issues where I need to go digging into the private TypeScript style guide to figure out why rules are the way they are.
I think we should have the TypeScript rules published here: https://github.com/google/styleguide
And have a public page similar to this: https://google.github.io/styleguide/jsguide.html
In fullness of time - I think convergence is the only viable option. One set of rules, internally and externally. I think it’s great to engage in conversations about the rules, with the understanding that at the end of the day we have the final call.