From 6124ce1e2603faab61026a689927e830de880b3a Mon Sep 17 00:00:00 2001 From: HIMAN PATRA <33486160+HIMANKARLIS@users.noreply.github.com> Date: Thu, 1 Oct 2020 22:21:44 +0530 Subject: [PATCH] Update README.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index db13d00e79..a82266cc35 100755 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Google Chrome Samples === -Samples tied to new functionality in Google Chrome. +Samples tied to new functionalities of Google Chrome. Each sample corresponds to an entry in https://www.chromestatus.com/features, and using that interface is currently the best way to browse. @@ -23,23 +23,23 @@ If you're still unsure, two canonical samples that use templates are: Follow the [Using Jekyll with Pages](https://help.github.com/articles/using-jekyll-with-pages/) guide to mimic the production Jekyll environment during local development. -Once complete, please file a pull request against the `gh-pages` branch with your sample. -It's ideal when filing a pull request @-mention the relevant engineer who worked on adding the +Once completed, please file a pull request against the `gh-pages` branch with your sample. +It's ideal when filing a pull request @-mention the relevant engineer who has worked on adding the feature into Chrome, to solicit their feedback and ensure that the sample properly describes the functionality. The email address of the engineer who worked on a given feature can be found in the corresponding https://www.chromestatus.com/features entry. If you're unsure of the GitHub -username corresponding to the engineer, an alternative is to email them a link to the pull request +username corresponding to the engineer, an alternative way is to email them a link to the pull request and ask for feedback directly. Style / Linting / CI === The samples ideally should follow the [Google JavaScript Style Guide](http://google.github.io/styleguide/javascriptguide.xml), and that's enforced via [ESLint](), using the [`eslint-config-google`](https://github.com/google/eslint-config-google) -base configuration, with a few overrides as needed. +base configurations, with a few overrides as needed. Linting can be performed via `npm run lint` (make sure to `npm install` first). -Various IDEs offer [real-time ESLint integration](http://eslint.org/docs/user-guide/integrations.html), +Various IDEs offers [real-time ESLint integration](http://eslint.org/docs/user-guide/integrations.html), and using those integrations that can help avoid errors before anything gets checked in.