Skip to content
#

best-practices

Here are 865 public repositories matching this topic...

sadokmtir
sadokmtir commented Jan 21, 2020

I think it is worth mentioning that the solution stated Catching unresolved and rejected promises is not always valid. what I mean is that if a promise is caught on a later turn of the Node.js event loop, then probably throwing an error on this global catch is not a good idea. I am wondering how this is counted as best practice while obviously from the node official documentation it should

exterkamp
exterkamp commented Jan 31, 2020

The double dollar assertion: https://github.com/GoogleChrome/lighthouse/blob/e87a8b76e66208be0266c6e3a3b648dbebe79521/lighthouse-core/scripts/i18n/collect-strings.js#L344

Is a bit aggressive, it should check for basic $$ but allow $ICU_0$$ICU_1$. This should be validated with regex like \$([^$]*?)\$ and asserting that each capture group isn't empty instead of a more basic \$\$.

rbsec
rbsec commented Sep 1, 2019

When you're viewing a cheatsheet on the https://cheatsheetseries.owasp.org website it isn't immediately obvious that the content is pulled from GitHub, or how you could contribute to the project on the cheatsheets themselves (although there is a note at the bottom of the homepage).

Making this more obvious in the sheets themselves will encourage people to contribute (or at least raise issues).

davidak
davidak commented Aug 31, 2019

https://opensource.guide/legal/

It is not clear to me how i should practically note the copyright of a code part (for example 5 lines from a MIT project). Is it legally OK to just note the source, author and license in the commit message description or should it be in the header of the file or in the LICENSE file of the project?

When i copy whole files, the license header should not be r

dipanjan77
dipanjan77 commented Aug 12, 2019

Description

Add a ReadMe file in the GitHub folder.
Explain usage of the Templates

Other Comments

Principles of NLP Documentation
Each landing page at the folder level should have a ReadMe which explains -
○ Summary of what this folder offers.
○ Why and how it benefits users
○ As applicable - Documentation of using it, brief description etc
Scenarios folder:

Improve this page

Add a description, image, and links to the best-practices topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the best-practices topic, visit your repo's landing page and select "manage topics."

Learn more

You can’t perform that action at this time.