Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write basic JS docs #61

Open
ryekerjh opened this issue Jan 12, 2019 · 3 comments
Open

Write basic JS docs #61

ryekerjh opened this issue Jan 12, 2019 · 3 comments
Assignees
Labels
Good First Contribution If you're new to contributing, these are PERFECT for you help wanted

Comments

@ryekerjh
Copy link
Contributor

In our repo we have a client-side/javascript doc that needs some contributions. Ideally we will link to the Google JS standards and all of us together will create a style guide for how we write JS.

@ryekerjh ryekerjh added help wanted Good First Contribution If you're new to contributing, these are PERFECT for you labels Jan 12, 2019
@ryekerjh ryekerjh changed the title Write basic JS docsq Write basic JS docs Jan 12, 2019
@michaelachrisco
Copy link
Contributor

So at the moment, we have some JS frameworks here: https://github.com/Shift3/standards-and-practices/tree/master/best-practices/client-side/framework

Do we want to add JS specific best practices to the best-practices/native page? What has helped in the past when writing, styling and running javascript?

@ryekerjh
Copy link
Contributor Author

ryekerjh commented Aug 7, 2020

@michaelachrisco I had a very eye-opening talk the other day with a more senior dev I know and he challenged me to ask myself the why. In other words, are we reinventing the wheel by writing our own versions of these JS best practices? Is there an existing resource we can link to that would be just as effective, but would take us less time? What are your thoughts?

@Karvel
Copy link
Contributor

Karvel commented Aug 7, 2020

I would say that compiling resources is fine. Often times people will lightly curate resources and guides. Part of best practices for a shop is defining a common standard. Javascript is an especially open ended language that allows many different approaches. It's helpful to have resources that support shop style. For instance, we encourage using TypeScript for most Javascript projects and Flow for React.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Good First Contribution If you're new to contributing, these are PERFECT for you help wanted
Projects
None yet
Development

No branches or pull requests

7 participants