From f73d1288c7b38c477dfd786f4b4e90c46bcfd8fb Mon Sep 17 00:00:00 2001 From: AderKonstantin <66168124+AderKonstantin@users.noreply.github.com> Date: Mon, 9 Dec 2024 12:01:26 +0300 Subject: [PATCH] Update CONTRIBUTING.md Signed-off-by: AderKonstantin <66168124+AderKonstantin@users.noreply.github.com> --- CONTRIBUTING.md | 56 ++++++++++++++++++++++++------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc796ca..7389dac 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,22 @@ # Code Style Guide to 'RobotFire' Repo -Обращаться к [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) и к [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html) +Не является обязательством, но было бы очень приятно🙂 +Обращаться к [Conventional Commits](https://www.conventionalcommits.org/ru/v1.0.0/) и к [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html) ## Coding Rules -To ensure consistency throughout the source code, keep these rules in mind as you are working: +Чтобы обеспечить единообразие во всем исходном коде, помните об этих правилах во время работы: -* All features or bug fixes **must be tested** by one or more specs (unit-tests). -* All public API methods **must be documented**. (Details TBC). -* We follow [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html), but wrap all code at +* Все функции или исправления ошибок **должны быть протестированы** одной или несколькими спецификациями (unit-tests). +* Все публичные методы API **должны быть документированы(сопровождаться комментариями)**. +* Мы следуем [Google C# Style Guide](https://google.github.io/styleguide/csharp-style.html), но оберните весь код в **100 characters**. -We have very precise rules over how our git commit messages can be formatted. This leads to **more -readable messages** that are easy to follow when looking through the **project history**. But also, -we use the git commit messages to **generate the Angular change log**. +У нас есть очень точные правила относительно того, как могут быть отформатированы наши сообщения коммита git. Это приводит к **более +читабельным сообщениям**, которые легко отслеживать при просмотре **истории проекта**. Но также, +мы используем сообщения коммита git для **генерации журнала изменений кода**. ### Commit Message Format -Each commit message consists of a **header**, a **body** and a **footer**. The header has a special -format that includes a **type**, a **scope** and a **subject**: +Иметь сообщение к коммиту не обязательно. +Каждое сообщение о коммите состоит из **header**, **body** и **footer**. Заголовок имеет специальный формат, который включает **type**, **scope** и **subject**: ``` (): @@ -25,14 +26,13 @@ format that includes a **type**, a **scope** and a **subject**: