Feedback

.gitattributes

@@ -0,0 +1,6 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# These are explicitly windows files and should use crlf
+*.bat           text eol=crlf
+

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "gradle"
+    directory: "/"
+    schedule:
+      interval: "daily"

.github/mergeable.yml

@@ -0,0 +1,30 @@
+version: 2
+mergeable:
+  - when: pull_request.*, pull_request_review.*
+    filter:
+      # ignore 'Feedback' PR
+      - do: payload
+        pull_request:
+          title:
+            must_exclude:
+              regex: ^Feedback$
+              regex_flag: none
+    validate:
+      - do: description
+        no_empty:
+          enabled: true
+          message: "Description matter and should not be empty. Provide detail with **what** was changed, **why** it was changed, and **how** it was changed."
+      - do: approvals
+        min:
+          count: 1
+        required:
+          assignees: true
+
+  - when: pull_request.opened
+    name: "Remind about contributing guidelines"
+    validate: [ ]
+    pass:
+      - do: comment
+        payload:
+          body: >
+            Thanks for creating a pull request! Please, check that your pull request meets the [CONTRIBUTING](./CONTRIBUTING.md) requirements.

.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Run full build
+
+on:
+  push:
+jobs:
+  build-gradle-project:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ macos-latest, ubuntu-latest, windows-latest ]
+
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v3
+      - name: Setup Java 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: adopt
+          java-version: 11
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Run build with Gradle Wrapper
+        run: ./gradlew build
+
+      - uses: actions/upload-artifact@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          name: Upload coverage report
+          path: app/build/coverage/test/*

.gitignore

@@ -0,0 +1,85 @@
+.gradle
+**/build/
+!src/**/build/
+
+# Ignore Gradle GUI config
+gradle-app.setting
+
+# Cache of project
+.gradletasknamecache
+
+# Eclipse Gradle plugin generated files
+# Eclipse Core
+.project
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Compiled class file
+*.class
+
+# Log file
+*.log
+
+# BlueJ files
+*.ctxt
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.nar
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+replay_pid*
+
+.idea
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored)
+!gradle-wrapper.jar
+
+# Avoid ignore Gradle wrappper properties
+!gradle-wrapper.properties

CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Внесение правок
+
+## Основные советы
+
+1. Никогда не используйте merge, только rebase для сохранения линейной истории коммитов
+2. **Осторожно** с изменениями в чужих ветках. Придется больно и мучительно делать rebase. Лучше не трогайте чужие
+   ветки
+3. Перепроверьте историю коммитов перед созданием пулл реквеста
+4. Каждый коммит должен быть осознанным и быть одним логическим элементом
+5. Каждый пулл реквест должен быть осознанным и быть одним логическим элементом
+6. **Перепроверьте, что вы в правильной ветке**, никогда не коммитьте напрямую в main
+
+## Правила добавления коммитов
+
+Коммиты добавляются в соответствии с conventional commits. Т.е
+`<type>(<scope>): <body>`.
+
+Поле `<type>` должно принимать одно из этих значений:
+
+* `feat` для добавления новой функциональности
+* `fix` для исправления бага в программе
+* `refactor` для рефакторинга кода, например, переименования переменной
+* `test` для добавления тестов, их рефакторинга
+* `struct` для изменений связанных с изменением структуры проекта (НО НЕ КОДА), например изменение
+  расположения папок
+* `ci` для различных задач ci/cd
+
+Поле `<scope>` опционально и показывает к какому модулю, классу, методу функции и т.п применены изменения.
+
+Поле `<body>` содержит суть изменений в повелительном наклонении настоящего времени на английском языке без точки в
+конце, первое слово - глагол с большой буквы. Текст сообщения должен включать мотивацию к изменению и контрасты с
+предыдущим поведением.
+
+Примеры:
+
+* Хорошо: "Add module for future BST implementations"
+* Плохо: "Added module for future BST implementations."
+* Плохо: "Adds module".
+* Очень плохо: "new bug."
+
+## Правила именования и создания веток
+
+Ветка под одно (большое) логическое изменение. Формат для веток `<type>/<short-body>`. Тип аналогичен тому же в
+коммитах,
+а `<short-body>` представляет собой короткое описание назначения ветки в kebab-case стиле.
+
+Примеры хороших названий:
+
+* `feat/add-avl-tree`
+* `ci/add-klint`
+
+После одобрения пулл реквеста, ветка удаляется. А новая функциональность разрабатывается в новой ветке.
+
+## Правила для пулл реквестов
+
+Пулл реквесты оформляются на любом удобном языке. Но должны четко отвечать на 3 вопроса:
+
+1. Что?
+2. Зачем?
+3. Почему?
+
+Ответ на вопрос что должен содержаться в заголовке пулл реквеста. На остальные вопросы ответ должен быть в описании.
+
+**НЕ ТЫКАТЬ НА ЗЕЛЕНУЮ КНОПОЧКУ `REBASE AND MERGE` БЕЗ РЕВЬЮ**
+
+**Запрещено** сливать свой пулл реквест в ветку самостоятельно.
+
+Если тыкаете на зеленую кнопочку, то **убедитесь**, что на ней написано `REBASE AND MERGE`
+
+Ревью происходит в виде комметариев к пулл реквестам, обсуждения в чате команды и личном общении.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Yakshigulov Vadim, Dyachkov Vitaliy, Perevalov Efim
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.