Merge pull request #668 from songe/korean-translation

Merge branch 'master' into korean-translation

.operations/.markdownlint.json

@@ -0,0 +1,7 @@
+{
+  "default": true,
+  "MD033": false,
+  "MD001": false,
+  "MD013": false,
+  "MD039": false
+}

.operations/CONTRIBUTING.md

@@ -1,3 +1,22 @@
+# Contribution guidelines
+
+## What you should know first?
+
+### Lovely & friendly atmosphere
+
+Our code of conduct is 5 words long: we are all friends here
+
+We recognize that being professional and kind are the same thing and strive to maximize our professionalism
+
+### Maintenance work
+
+Our operations manual [can be found here](https://github.com/goldbergyoni/nodebestpractices/blob/master/.operations/operations-manual.md)
+
+### Writing guidelines
+
+Our content writing guidelines [can be found here](https://github.com/goldbergyoni/nodebestpractices/blob/master/.operations/writing-guidelines.md)
+
+
 ## Contribution model
 
 ### Steering committee 🏆
@@ -12,6 +31,14 @@ The role is in place to help the steering committee ensure that the content prov
 
 The steering committee periodically reviews the collaborator list to identify inactive collaborators. Inactive collaborators can choose to either continue in or step down from their role, in which case they are acknowledged as a past collaborator. They may later request that the steering committee restore them to active status.
 
-### Flowers and stars
+### Other contributions ✨
+
+This project follows the [All Contributors Specification](https://allcontributors.org/), which means we recognize all types of contributions, whether they are new suggested best practices/ideas, translations, or new content.
+
+If you have contributed to the project in some way and aren't listed, please add an entry for yourself by using the @all-contributors-bot in a Pull Request or issue. Examples:
+
+`@all-contributors-bot please add @js-kyle for code`
+
+`@all-contributors-bot please add @brunoscheufler for content`
 
-Every addition to the project are acknowledged by the author gaining a place on the home page. A flower 🌻 marks a successful pull request. A star of honor ⭐ is assigned to contributors who propose and write a new best practice to our guide.
+Contribution types are listed [here](https://allcontributors.org/docs/en/emoji-key).

.operations/operations-manual.md

@@ -40,18 +40,14 @@ Each month, a maintainer on call will open an issue for maintenance work and rec
 
 | Month   | Maintainer on call |
 |---------|--------------------|
-| 10/2018 | Sagir              |
-| 11/2018 | Bruno              |
-| 12/2018 | Yoni               |
-| 01/2019 | Kyle               |
-| 02/2019 | Sagir              |
-| 03/2019 | Bruno              |
-| 04/2019 | Yoni               |
-| 05/2019 | Kyle               |
-| 06/2019 | Sagir              |
-| 07/2019 | Bruno              |
-| 09/2019 | Yoni               |
-
+| 10/2019 | Yoni               |
+| 12/2019 | Bruno              |
+| 02/2020 | Kyle               |
+| 04/2020 | Yoni               |
+| 06/2020 | Bruno              |
+| 08/2020 | Kyle               |
+| 10/2020 | Yoni               |
+| 12/2020 | Bruno              |
 
 <br/>
 
@@ -75,18 +71,19 @@ Each month, a maintainer on call will open an issue for maintenance work and rec
 
 | Language             | Assignee |
 |----------------------|----------|
-| Brazilian Portuguese | Sagir    |
-| Portuguese           | Sagir    |
+| Brazilian Portuguese | Bruno    |
+| Portuguese           | Kyke     |
 | Hebrew               | Yoni     |
 | German               | Bruno    |
 | Italian              | Kyle     |
 | Turkish              | Bruno    |
 | French               | Yoni     |
-| Russian              | Sagir    |
+| Russian              | Yoni     |
 | Korean               | Yoni     |
-| Spanish              | Kyle     |
+| Spanish              | Kevyn    |
 | Chinese              | Yoni     |
 | Korean               | Kyle     |
 | Egyptian             | Yoni     |
-| Ukrainian            | Bruno     |
+| Ukrainian            | Bruno    |
+| Polish.              | Kevyn    |
 

.operations/package.json

@@ -5,7 +5,8 @@
   "main": "gen-html.js",
   "scripts": {
     "build": "cd .. && node .operations/gen-html.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "./node_modules/.bin/markdownlint ../README.md"
   },
   "repository": {
     "type": "git",
@@ -24,6 +25,7 @@
     "imagemin": "^6.0.0",
     "imagemin-jpegtran": "^6.0.0",
     "imagemin-pngquant": "^6.0.0",
+    "markdownlint-cli": "^0.18.0",
     "showdown": "^1.9.0"
   }
 }

.operations/writing-guidelines.md

@@ -1,31 +1,31 @@
 # Our content writing manifest
-How we enhance the reading and learning experience for our visitors
 
-## 1. Simple is better than better
+How we enhance the reading and learning experience for our visitors.
 
-<br/>
-Making it easy to read and absorb knowledge is our mission, we curate content. As such we focus on transforming complex and exhausting topics into a simplified list, trade overloaded information with shortened and less-accurate details, avoid ‘flammable’ and controversial topics and escape subjective ideas in favor of generally accepted practices
+## 1. Simple is better than better
 
-<br/>
+Making it easy to read and absorb knowledge is our mission, we curate content. As such we focus on transforming complex and exhausting topics into a simplified list, trade overloaded information with shortened and less-accurate details, avoid ‘flammable’ and controversial topics and escape subjective ideas in favor of generally accepted practices.
 
 ## 2. Be evidence-based and reliable
 
-<br/>
-Our readers should have great confidence that the content they skim through is reliable. We achieve this by including evidence like references, data and other resources available to this topic. Practically, strive to include quotes from reliable sources, show benchmarks, related design patterns or any scientific measure to prove your claims
+Our readers should have great confidence that the content they skim through is reliable. We achieve this by including evidence like references, data and other resources available to this topic. Practically, strive to include quotes from reliable sources, show benchmarks, related design patterns or any scientific measure to prove your claims.
 
+## 3. MECE (Mutually Exclusive and Collectively Exhaustive)
 
-## 3.	MECE (Mutually Exclusive and Collectively Exhaustive)
-Apart from the content being greatly edited and reliable, skimming through it should also provide full coverage of the topic. No important sub-topic should be left out
+Apart from the content being greatly edited and reliable, skimming through it should also provide full coverage of the topic. No important sub-topic should be left out.
 
 ## 4. Consistent formatting
-The content is presented using fixed templates. Any future content must conform to the same template. If you wish to add new bullets copy a bullet format from an existing bullet and extend it to your needs. For additional information please view [this template](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md)
+
+The content is presented using fixed templates. Any future content must conform to the same template. If you wish to add new bullets copy a bullet format from an existing bullet and extend it to your needs. For additional information please view [this template](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md).
 
 ## 5. It's About Node.js
-Each advice should be related directly to Node.js and not to software development in general. When we advise to implement generic pattern/rule in Node.js, the content should focus on the Node implementation. For example, when we advise to sanitize all requests input for security reasons, Node-lingo should be used - ‘Use middleware to sanitize request input’. If an item has no specific implementation in Node.js (e.g. it looks the same in Python & Jaba) - include it within a generic container item, see item 6.5 for example
+
+Each advice should be related directly to Node.js and not to software development in general. When we advise to implement generic pattern/rule in Node.js, the content should focus on the Node implementation. For example, when we advise to sanitize all requests input for security reasons, Node-lingo should be used - ‘Use middleware to sanitize request input’. If an item has no specific implementation in Node.js (e.g. it looks the same in Python & Jaba) - include it within a generic container item, see item 6.5 for example.
 
 ## 6. Leading vendors only
+
 Sometimes it's useful to include names of vendors that can address certain challenges and problems like npm packages, open source tools or even commercial products. To avoid overwhelmingly long lists or recommending non-reputable and unstable projects, we came up with the following rules:
 
--	Only the top 3 vendors should be recommended – a vendor that appears in the top 3 results of a search engine (Google or GitHub sorted by popularity) for a given relevant keyword can be included in our recommendation
--	If it’s a npm package it must also be downloaded at least 750 times a day on average
--	If it’s an open-source project, it must have been updated at least once in the last 6 months
+- Only the top 3 vendors should be recommended – a vendor that appears in the top 3 results of a search engine (Google or GitHub sorted by popularity) for a given relevant keyword can be included in our recommendation.
+- If it’s a npm package it must also be downloaded at least 750 times a day on average.
+- If it’s an open-source project, it must have been updated at least once in the last 6 months.

.operations/writing-guidelines.polish.md

@@ -0,0 +1,31 @@
+# Nasz manifest pisania treści
+
+Jak zwiększamy komfort czytania i uczenia się dla naszych gości.
+
+## 1. Proste jest lepsze
+
+Naszą misją jest ułatwianie czytania i przyswajania wiedzy. Dlatego koncentrujemy się na przekształcaniu skomplikowanych i wyczerpujących tematów w uproszczoną listę, handlujemy przeciążonymi informacjami ze skróconymi i mniej dokładnymi szczegółami, unikamy „łatwopalnych” i kontrowersyjnych tematów i unikamy subiektywnych pomysłów na rzecz ogólnie przyjętych praktyk.
+
+## 2. Bądź wiarygodny i niezawodny
+
+Nasi czytelnicy powinni mieć wielką pewność, że przeglądane przez nich treści są wiarygodne. Osiągamy to poprzez włączenie dowodów, takich jak referencje, dane i inne zasoby dostępne na ten temat. Praktycznie staraj się zamieszczać cytaty z wiarygodnych źródeł, wykazywać wzorce, powiązane wzorce projektowe lub wszelkie środki naukowe, aby udowodnić swoje twierdzenia.
+
+## 3. MECE (Mutually Exclusive and Collectively Exhaustive)
+
+Oprócz tego, że treść jest znacznie edytowana i niezawodna, przeglądanie w niej powinno również zapewniać pełne omówienie tematu. Nie można pominąć żadnego ważnego tematu.
+
+## 4. Spójne formatowanie
+
+Treść jest prezentowana przy użyciu stałych szablonów. Wszelkie przyszłe treści muszą być zgodne z tym samym szablonem. Jeśli chcesz dodać nowe punktory, skopiuj format punktora z istniejącego i rozszerz go do swoich potrzeb. Aby uzyskać dodatkowe informacje, zobacz [ten szablon](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md).
+
+## 5. To na temat Node.js
+
+Każda rada powinna dotyczyć bezpośrednio Node.js, a nie ogólnie oprogramowania. Kiedy radzimy zaimplementować ogólny wzorzec / regułę w Node.js, treść powinna koncentrować się na implementacji Node. Na przykład, gdy ze względów bezpieczeństwa zalecamy oczyszczenie danych wejściowych, należy użyć Node-lingo - „Użyj oprogramowania pośredniego do oczyszczenia danych wejściowych”. Jeśli element nie ma określonej implementacji w Node.js (np. wygląda tak samo w Python i Jaba) - dołącz go do ogólnego elementu kontenera, patrz na przykład pozycja 6.5.
+
+## 6. Tylko wiodący dostawcy
+
+Czasami przydatne jest podanie nazw dostawców, którzy mogą rozwiązać niektóre wyzwania i problemy, takie jak pakiety npm, narzędzia open source, a nawet produkty komercyjne. Aby uniknąć przytłaczających długich list lub rekomendować projekty nierenomowane i niestabilne, opracowaliśmy następujące zasady:
+
+- Polecamy tylko 3 najlepszych dostawców - dostawcę, który pojawia się w 3 najlepszych wynikach wyszukiwania (Google lub GitHub posortowane według popularności) dla danego odpowiedniego słowa kluczowego, możemy uwzględnić w naszej rekomendacji.
+- Jeśli jest to pakiet npm, musi być pobierany średnio co najmniej 750 razy dziennie.
+- Jeśli jest to projekt typu open source, musi zostać zaktualizowany przynajmniej raz w ciągu ostatnich 6 miesięcy.

.operations/writing-guidelines.russian.md

@@ -0,0 +1,31 @@
+# Наш манифест по написанию контента
+
+Как мы улучшаем процесс чтения и обучения для наших посетителей.
+
+## 1. Простое лучше, чем лучшее
+
+Наша миссия - облегчить чтение и усвоение знаний, мы курируем контент. Таким образом, мы концентрируемся на преобразовании сложных и изнурительных тем в упрощенный список, обмениваем перегруженную информацию сокращенными и менее точными деталями, избегаем "легковоспламеняющихся" и противоречивых тем и избегаем субъективных идей в пользу общепринятых практик.
+
+## 2. Быть обоснованным и надежным
+
+Наши читатели должны быть уверены, что контент, который они просматривают, надежен. Мы достигаем этого путем включения таких доказательств, как ссылки, данные и другие ресурсы, доступные по этой теме. Практически, старайтесь включать цитаты из надежных источников, показывать контрольные показатели, связанные шаблоны проектирования или любые научные меры, чтобы доказать свои претензии.
+
+## 3. ВИСИ (взаимоисключающие и совместноисчерпывающие)
+
+Помимо того, что контент хорошо отредактирован и надежен, его просмотр должен также обеспечить полное освещение темы. Ни одна важная подтема не должна быть исключена.
+
+## 4. Согласованное форматирование
+
+Контент представлен с использованием фиксированных шаблонов. Любое будущее содержание должно соответствовать тому же шаблону. Если вы хотите добавить новые маркеры, скопируйте формат маркера из существующего маркера и расширьте его для своих нужд. Для получения дополнительной информации, пожалуйста, просмотрите [этот шаблон](https://github.com/i0natan/nodebestpractices/blob/master/sections/template.md).
+
+## 5. Это про Node.js
+
+Каждый совет должен быть связан непосредственно с Node.js, а не с разработкой программного обеспечения в целом. Когда мы советуем реализовать общий шаблон/правило в Node.js, содержимое должно быть сосредоточено на реализации Node. Например, когда мы советуем очистить все запросы ввода по соображениям безопасности, следует использовать Node-нотацию - "используйте промежуточное ПО для очистки ввода запроса". Если у элемента нет конкретной реализации в Node.js (например, он выглядит одинаково в Python и Jaba) - включите его в общий элемент контейнера, см., например, пункт 6.5.
+
+## 6. Только ведущие поставщики
+
+Иногда полезно включать имена поставщиков, которые могут решить определенные задачи и проблемы, такие как пакеты npm, инструменты с открытым исходным кодом или даже коммерческие продукты. Чтобы избежать слишком длинных списков или рекомендовать не заслуживающие доверия и нестабильные проекты, мы разработали следующие правила:
+
+- Рекомендуются только топ-3 поставщиков - в нашу рекомендацию может быть включен поставщик, который появляется в топ-3 результатов поисковой системы (Google или GitHub по популярности) для данного релевантного ключевого слова.
+- Если это пакет npm, его также должны скачивать в среднем не менее 750 раз в день.
+- Если это проект с открытым исходным кодом, он должен быть обновлен хотя бы один раз за последние 6 месяцев.

.travis.yml

@@ -6,4 +6,5 @@ script:
   - export PR=https://api.github.com/repos/$TRAVIS_REPO_SLUG/pulls/$TRAVIS_PULL_REQUEST
   - export BRANCH=$(if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then echo $TRAVIS_BRANCH; else echo `curl -s $PR | jq -r .head.ref`; fi)
   - echo "TRAVIS_BRANCH=$TRAVIS_BRANCH, PR=$PR, BRANCH=$BRANCH"
+  - npm run lint
   - npm run build