69e1efcb04
Removed the unnecessary de
...
In this sentence the "de" is incorrect.
2019-03-15 04:52:17 -05:00
f97d1fb36f
Corrected some typos
2019-03-14 17:27:05 -03:00
0d42376dd7
translated fail fast
2019-03-14 17:23:42 -03:00
98463adc98
translated catch unhandled promise rejection
2019-03-14 17:11:28 -03:00
4b75491f44
translated apm products
2019-03-14 16:52:47 -03:00
4b350941e7
translated testing error flows
2019-03-14 16:35:18 -03:00
bbdca965fe
translated use mature logger
2019-03-14 16:24:05 -03:00
cc81fa0008
translated shutting the process
2019-03-14 15:59:45 -03:00
2ce97d0746
translated documenting using swagger
2019-03-14 15:31:52 -03:00
09f9c49d74
translated centralized handling
2019-03-14 15:11:38 -03:00
29eefda372
translated operational vs programmer error
2019-03-14 12:45:38 -03:00
7bb737aadd
correted a typo
2019-03-14 12:44:59 -03:00
78217bbe6d
translated use only the built-in Error
2019-03-13 23:25:02 -03:00
c85ff26851
fixed typo
2019-03-13 23:17:08 -03:00
965023065f
Fixed some typos
2019-03-13 22:46:11 -03:00
cfce3611a5
translated code comments
2019-03-13 22:18:22 -03:00
add174d4aa
translated async error handling
2019-03-13 21:43:28 -03:00
8888b23462
Updated README.brazilian-portuguese.md ( #357 )
...
Translated section 4.2
2019-03-14 00:09:30 +05:30
9aa448cc53
Updated README.brazilian-portuguese.md
...
Translated section 4.2
2019-03-13 13:30:55 -03:00
9c1636bc0b
Merge pull request #1 from i0natan/master
...
update
2019-03-13 13:13:58 -03:00
8d3c6a53dc
Update README.brazilian-portuguese.md ( #356 )
...
Ortographic errors correction and transtalation of non-translated english paragraph on portuguese translation version
2019-03-13 08:38:48 +05:30
96a05abce5
Merge pull request #355 from DouglasMV/master
...
Fixed Anchors at brazilian translation
2019-03-11 19:09:03 +01:00
7ccb9b2253
Fixed Anchors at brazilian translation
...
Fixed anchors for chapters 5, 6 and 7 at README.brazilian-portuguese.md
2019-03-11 14:23:29 -03:00
cfb9c8662c
Merge pull request #353 from i0natan/mar-19-chores
...
Service Feb 2019 maintenance chores
2019-03-10 11:52:59 +01:00
f0f7941871
chore(march-2019): update news section
...
- Announce availability of BR translation in the news section!
2019-03-10 16:19:26 +05:30
4b28dae8c4
chore(march-2019): align KR translation with the English version
...
- Update top badges, flowers and stars
diff --git a/README.korean.md b/README.korean.md
index 0cadfb5b..e94ef045 100644
--- a/README.korean.md
+++ b/README.korean.md
@@ -9,7 +9,7 @@
<br/>
<div align="center">
- <img src="https://img.shields.io/badge/⚙%20Item%20count%20-%2079%20Best%20practices-blue.svg " alt="79 items"> <img src="https://img.shields.io/badge/%F0%9F%93%85%20Last%20update%20-%20Feb%201%202019-green.svg " alt="Last update: February 1st, 2019"> <img src="https://img.shields.io/badge/%E2%9C%94%20Updated%20For%20Version%20-%20Node%2010.15.1%20LTS-brightgreen.svg " alt="Updated for Node 10.15.1 LTS">
+ <img src="https://img.shields.io/badge/⚙%20Item%20count%20-%2081%20Best%20Practices-blue.svg " alt="81 items"> <img src="https://img.shields.io/badge/%F0%9F%93%85%20Last%20update%20-%20Mar%2010%202019-green.svg " alt="Last update: March 10, 2019"> <img src="https://img.shields.io/badge/%E2%9C%94%20Updated%20For%20Version%20-%20Node%2010.15.3%20LTS-brightgreen.svg " alt="Updated for Node 10.15.3 LTS">
</div>
<br/>
@@ -152,7 +152,7 @@ 🔗 [**자세히 보기: Swagger에서 에러 문서화하기**](/sections/erro
## ![✔] 2.6 이상한 것이 들어왔을때 프로세스를 정상적으로 중단하라
-**핵심요약:** 알수 없는 에러(프로그래머 에러, 모범사례 #3번 참조)가 발생하면 어플리케이션의 건강상태에 대한 불확실성이 있다. 일반적인 방법은 Forever와 PM2 같은 '재시작' 도구로 프로세스를 다시 시작하는 것이다.
+**핵심요약:** 알수 없는 에러(프로그래머 에러, 모범사례 #3번 참조)가 발생하면 어플리케이션의 건강상태에 대한 불확실성이 있다. 일반적인 방법은 Forever와 PM2 같은 '재시작' 도구로 프로세스를 다시 시작하는 것이다.
**그렇게 하지 않을 경우:** 익숙치 않은 예외가 발생하면 일부 객체가 오류 상태(예를 들어 전역적으로 사용되지만 내부 오류로 인해 이벤트를 더이상 발생시키지 않는 Event Emitter)일 수 있으며 향후의 모든 요청이 실패하거나 미친것처럼(crazily) 동작할 수 있다.
@@ -216,7 +216,7 @@ 🔗 [**자세히 보기: 빠르게 실패하기**](/sections/errorhandling/fail
## ![✔] 3.1 ESLint를 사용하라
-**핵심요약:** [ESLint](https://eslint.org )는 발생 가능한 코드 에러를 체크하고 껄끄러운 간격(spacing)문제를 식별하는 것부터 프로그래머가 분별없이 에러를 던지는 것과 같은 코드의 심각한 안티 패턴을 감지하여 코드 스타일을 바꾸는 것에 대한 사실상의 표준이다. ESLint도 자동으로 코드스타일을 고칠 수 있지만 [prettier](https://www.npmjs.com/package/prettier )와 [beautify](https://www.npmjs.com/package/js-beautify )같은 수정 부분의 포맷을 맞춰주는 강력한 툴이 있고 ESLint와 함께 작동된다.
+**핵심요약:** [ESLint](https://eslint.org )는 발생 가능한 코드 에러를 체크하고 껄끄러운 간격(spacing)문제를 식별하는 것부터 프로그래머가 분별없이 에러를 던지는 것과 같은 코드의 심각한 안티 패턴을 감지하여 코드 스타일을 바꾸는 것에 대한 사실상의 표준이다. ESLint도 자동으로 코드스타일을 고칠 수 있지만 [prettier](https://www.npmjs.com/package/prettier )와 [beautify](https://www.npmjs.com/package/js-beautify )같은 수정 부분의 포맷을 맞춰주는 강력한 툴이 있고 ESLint와 함께 작동된다.
**그렇게 하지 않을 경우:** 프로그래머가 쓸데없는 간격과 한줄의 길이(line-width) 문제에 대해서 집중해야하고 프로젝트의 코드스타일에 대해 과도하게 생각하느라 시간을 낭비해야할 수도 있다.
@@ -267,12 +267,12 @@ 🔗 [**자세히 보기:** "왜 결과가 중괄호의 위치에 따라 달라
**핵심요약:** 클로저와 콜백을 포함한 모든 함수에 이름을 붙여라. 익명함수를 피해라. 이것은 노드 앱을 프로파일링 할때 특히 유용하다. 모든 함수를 명명하는 것은 당신이 메모리 스냅샷을 확인할때 당신이 보고있는 것이 무엇인지 쉽게 이해 할수있도록 해준다.
-**그렇게 하지 않을 경우:**
+**그렇게 하지 않을 경우:**
당신이 익명함수에서 메모리 소비가 많다는 것을 확인 했을 때 코어 덤프(메모리 스냅샷)을 이용해 프로덕션 문제를 디버깅하는 것이 어려울 수도 있습니다.
<br/><br/>
-## ![✔] 3.6 변수, 상수, 함수, 클래스의 명명 규칙(naming convention)
+## ![✔] 3.6 변수, 상수, 함수, 클래스의 명명 규칙(naming convention)
**핵심요약:** 상수와 변수 함수를 명명할때는 **_lowerCamelCase_** 를 사용하고 클래스를 명명 할때는 **_UpperCamelCase_**(첫 글자 대문자)를 사용하라. 이것은 일반 변수/함수와 인스턴스로 만들어야 하는 클래스를 구분하는데 도움을 것이다. 설명이 포함된 이름을 사용하되 이름을 짧게 유지하도록 해라.
@@ -754,9 +754,15 @@ 🌻 [Iman Mohamadi](https://github.com/ImanMh ),
🌻 [Remek Ambroziak](https://github.com/reod ),
🌻 [Sergii Paryzhskyi](https://github.com/HeeL ),
🌻 [Kapil Patel](https://github.com/kapilepatel ),
-🌻 [迷渡](https://github.com/justjavac )
-
-### Stars <br/>
+🌻 [迷渡](https://github.com/justjavac ),
+🌻 [Hozefa](https://github.com/hozefaj ),
+🌻 [Ethan](https://github.com/el-ethan ),
+🌻 [Sam](https://github.com/milkdeliver ),
+🌻 [Arlind](https://github.com/ArlindXh ),
+🌻 [Teddy Toussaint](https://github.com/ttous ),
+🌻 [Lewis](https://github.com/LewisArdern )
+
+### Stars
⭐ [Kyle Martin](https://github.com/js-kyle ),
⭐ [Keith Holliday](https://github.com/TheHollidayInn ),
2019-03-10 15:07:01 +05:30
0d1d81d36b
chore(march-2019): align CN translation with the English version
...
- Update top badges, flowers and stars
diff --git a/README.chinese.md b/README.chinese.md
index a17ab626..31e2073e 100644
--- a/README.chinese.md
+++ b/README.chinese.md
@@ -9,7 +9,7 @@
<br/>
<div align="center">
- <img src="https://img.shields.io/badge/⚙%20Item%20count%20-%2079%20Best%20practices-blue.svg " alt="79 items"> <img src="https://img.shields.io/badge/%F0%9F%93%85%20Last%20update%20-%20Feb%201%202019-green.svg " alt="Last update: February 1st, 2019"> <img src="https://img.shields.io/badge/%E2%9C%94%20Updated%20For%20Version%20-%20Node%2010.15.1%20LTS-brightgreen.svg " alt="Updated for Node 10.15.1 LTS">
+ <img src="https://img.shields.io/badge/⚙%20Item%20count%20-%2081%20Best%20Practices-blue.svg " alt="81 items"> <img src="https://img.shields.io/badge/%F0%9F%93%85%20Last%20update%20-%20Mar%2010%202019-green.svg " alt="Last update: March 10, 2019"> <img src="https://img.shields.io/badge/%E2%9C%94%20Updated%20For%20Version%20-%20Node%2010.15.3%20LTS-brightgreen.svg " alt="Updated for Node 10.15.3 LTS">
</div>
<br/>
@@ -96,7 +96,7 @@ 🔗 [**更多: 配置最佳实践**](/sections/projectstructre/configguide.chin
## ![✔] 2.1 使用 Async-Await 和 promises 用于异步错误处理
-**TL;DR:** 使用回调的方式处理异步错误可能是导致灾难的最快的方式(a.k.a the pyramid of doom)。对您的代码来说，最好的礼物就是使用规范的promise库或async-await来替代，这会使其像try-catch一样更加简洁，具有熟悉的代码结构。
+**TL;DR:** 使用回调的方式处理异步错误可能是导致灾难的最快的方式(a.k.a the pyramid of doom)。对您的代码来说，最好的礼物就是使用规范的promise库或async-await来替代，这会使其像try-catch一样更加简洁，具有熟悉的代码结构。
**否则:** Node.js回调特性, function(err, response), 是导致不可维护代码的一个必然的方式。究其原因，是由于混合了随意的错误处理代码，臃肿的内嵌，蹩脚的代码模式。
@@ -283,17 +283,17 @@ 🔗 [**更多:** "Why does a results vary based on curly brace placement?" (Sta
### 代码示例 ###
```javascript
// 使用UpperCamelCase命名类名
- class SomeClassExample () {
-
+ class SomeClassExample () {
+
// 常量使用const关键字，并使用lowerCamelCase命名
const config = {
key: 'value'
};
-
+
// 变量和方法使用lowerCamelCase命名
let someVariableExample = 'value';
function doSomething() {
-
+
}
}
@@ -485,7 +485,7 @@ 🔗 [**更多: 监控!**](/sections/production/monitoring.chinese.md)
🔗 [**更多: 使用智能日志增加透明度**](/sections/production/smartlogging.chinese.md)
-
+
<br/><br/>
## ![✔] 5.3. 委托可能的一切（例如：gzip，SSL）给反向代理
@@ -519,7 +519,7 @@ 🔗 [**更多: 锁住依赖**](/sections/production/lockdependencies.chinese.md
🔗 [**更多: 使用正确的工具保护进程正常运行**](/sections/production/guardprocess.chinese.md)
-
+
<br/><br/>
## ![✔] 5.6. 利用CPU多核
@@ -617,7 +617,7 @@ 🔗 [**更多: 使用自动检测漏洞的工具**](/sections/production/detect
<br/><br/>
-## ![✔] 5.14. 在每一个log语句中指明 ‘TransactionId’
+## ![✔] 5.14. 在每一个log语句中指明 ‘TransactionId’
**TL;DR:** 在每一个请求的每一条log入口，指明同一个标识符，transaction-id: {某些值}。然后在检查日志中的错误时，很容易总结出前后发生的事情。不幸的是，由于Node异步的天性自然，这是不容易办到的，看下代码里面的例子
@@ -951,10 +951,10 @@ Independent Node.js consultant who works with customers at USA, Europe and Israe
👨💻 Software engineer, 🌐 web developer, 🤖 emojis enthusiast.
## `Refael Ackermann` [@refack](https://github.com/refack ) <refack@gmail.com> (he/him)
-Node.js Core Collaborator, been noding since 0.4, and have noded in multiple production sites. Founded `node4good` home of [`lodash-contrib`](https://github.com/node4good/lodash-contrib ), [`formage`](https://github.com/node4good/formage ), and [`asynctrace`](https://github.com/node4good/asynctrace ).
+Node.js Core Collaborator, been noding since 0.4, and have noded in multiple production sites. Founded `node4good` home of [`lodash-contrib`](https://github.com/node4good/lodash-contrib ), [`formage`](https://github.com/node4good/formage ), and [`asynctrace`](https://github.com/node4good/asynctrace ).
`refack` on freenode, Twitter, GitHub, GMail, and many other platforms. DMs are open, happy to help.
-## `Bruno Scheufler`
+## `Bruno Scheufler`
💻 full-stack web developer and Node.js enthusiast.
## `Kyle Martin` [@js-kyle](https://github.com/js-kyle )
@@ -1031,13 +1031,19 @@ 🌻 [Iman Mohamadi](https://github.com/ImanMh ),
🌻 [Remek Ambroziak](https://github.com/reod ),
🌻 [Sergii Paryzhskyi](https://github.com/HeeL ),
🌻 [Kapil Patel](https://github.com/kapilepatel ),
-🌻 [迷渡](https://github.com/justjavac )
+🌻 [迷渡](https://github.com/justjavac ),
+🌻 [Hozefa](https://github.com/hozefaj ),
+🌻 [Ethan](https://github.com/el-ethan ),
+🌻 [Sam](https://github.com/milkdeliver ),
+🌻 [Arlind](https://github.com/ArlindXh ),
+🌻 [Teddy Toussaint](https://github.com/ttous ),
+🌻 [Lewis](https://github.com/LewisArdern )
-### Stars <br/>
+### Stars
⭐ [Kyle Martin](https://github.com/js-kyle ),
⭐ [Keith Holliday](https://github.com/TheHollidayInn ),
⭐ [Corey Cleary](https://github.com/coreyc ),
⭐ [Maximilian Berkmann](https://github.com/Berkmann18 )
-<br/><br/>
+<br/><br/><br/>
2019-03-10 15:04:32 +05:30
d4e69a544f
chore(march-2019): align BR translation with the English version
...
- Ensure BR translation is aligned with the English version
2019-03-10 15:00:42 +05:30
8f6a2d0584
chore(march-2019): service maintenance tasks
...
- Update top badges with
1. best practices item count (81 as on Mar 10, 2019)
2. last update date (Mar 10, 2019)
3. Node.js version (latest LTS - 10.15.3)
- Update 'thank you' stars & flowers
Closes: https://github.com/i0natan/nodebestpractices/issues/338
2019-03-10 14:27:01 +05:30
f0670e0e81
Merge BR translation into master ( #351 )
...
Merge BR translation into master, finally!
Please turn on the `No Whitespace` option during review.
/cc @marcelosdm
Closes: https://github.com/i0natan/nodebestpractices/issues/223
2019-03-10 12:31:22 +05:30
a83aa00464
fix markdown error ( #349 )
2019-03-05 12:30:39 +05:30
cfaa28ddbd
Merge pull request #328 from i0natan/contribution_model
...
Adds detail on contribution model
2019-03-05 18:11:56 +13:00
6085af6f54
Merge branch 'master' into contribution_model
2019-03-05 18:11:19 +13:00
9811373046
Merge pull request #330 from hozefaj/fix-typos
...
docs: fix typos and couple spelling changes
2019-03-03 14:57:02 +01:00
99daf1ee99
Merge pull request #347 from LewisArdern/patch-3
...
Updates to commonsecuritybestpractices.md
2019-03-02 12:10:16 +13:00
b21778c7e0
Merge branch 'master' into contribution_model
2019-03-02 11:45:33 +13:00
78004e199f
update httpOnly
...
Technically its HttpOnly, so i updated to reflect that.
2019-02-26 13:40:30 -08:00
637523810d
Updates to commonsecuritybestpractices.md
...
Did not like that OWASP A7 only included 'use CSP, so updated that to reference more content from OWASP with some slight changes to reflect node, e.g use a template engine.
Made some slight changes to the content for grammar improvements
2019-02-25 15:11:31 -08:00
ed2c333af5
Merge pull request #335 from milkdeliver/patch-1
...
Update guardprocess.chinese.md
2019-02-25 08:40:42 +08:00
0f836d69f7
Merge branch 'master' into fix-typos
2019-02-23 17:39:57 +01:00
4a4a740ce1
Merge pull request #344 from LewisArdern/patch-2
...
Grammar improvements to secureserver.md
2019-02-22 17:57:59 +01:00
807fe9dea8
Slight changes
...
Suggested changes from comments
2019-02-22 08:26:25 -08:00
a1477e4a09
Grammar improvements to secureserver.md
...
I read this page and saw a few grammar improvements, hopefully you like them.
2019-02-21 17:06:02 -08:00
03fb73dbdf
Merge pull request #342 from LewisArdern/patch-1
...
Include new Function within avoideval.md
2019-02-22 09:48:21 +13:00
263e270bb2
Merge pull request #339 from i0natan/news-and-updates
...
Added 'News' section + new BP 4.2
2019-02-20 21:31:56 +02:00
830907a958
Include new Function within avoideval.md
...
Dynamic execution of JavaScript also happens in new Function, which is even referenced here: https://github.com/i0natan/nodebestpractices#-615-avoid-javascript-eval-statements , so this should be included.
2019-02-20 07:40:20 -08:00
6287a7bf98
Per Bruno's remark
2019-02-18 09:18:53 +02:00
63b98c9b65
update collaborators
2019-02-18 16:33:51 +13:00
1b9be08cf2
Added news, updates and new BP: 4.2
2019-02-16 23:15:25 +02:00
89cf3079fe
Added news, updates and new BP: 4.2
2019-02-16 23:14:49 +02:00
