spbu-coding-2022 · github-classroom · Apr 2, 2023 · Apr 2, 2023 · Apr 3, 2023 · Apr 3, 2023
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,9 @@
+#
+# https://help.github.com/articles/dealing-with-line-endings/
+#
+# Linux start script should use lf
+/gradlew        text eol=lf
+
+# These are Windows script files and should use crlf
+*.bat           text eol=crlf
+
diff --git a/.github/mergeable.yml b/.github/mergeable.yml
@@ -0,0 +1,44 @@
+version: 2
+mergeable:
+  - when: pull_request.*, pull_request_review.*
+    filter:
+      # ignore 'Feedback' PR
+      - do: payload
+        pull_request:
+          title:
+            must_exclude:
+              regex: '^Feedback$'
+
+    validate:
+      # Work in progress
+      - do: title
+        must_exclude:
+          regex: '^\[WIP\]'
+      - do: label
+        must_exclude:
+          regex: 'wip'
+
+      # No empty description
+      - do: description
+        no_empty:
+          enabled: true
+          message: Description matter and should not be empty.
+
+      # Some approve
+      - do: approvals
+        min:
+          count: 1
+        required:
+          assignees: true
+
+
+      # Pull request to main only from release and hotfix branches
+      - do: or
+        validate:
+          - do: baseRef
+            must_exclude:
+              regex: '^main$'
+          - do: headRef
+            must_include:
+              regex: '^(release|hotfix)\/.+$'
+        message: "Create PR to main only from release and hotfix branches"
diff --git a/.github/workflows/actions.yml b/.github/workflows/actions.yml
@@ -0,0 +1,40 @@
+name: Build project
+
+on:
+  push:
+jobs:
+  build-gradle-project:
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout project sources
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          distribution: temurin
+          java-version: 11
+
+      - name: Setup Gradle
+        uses: gradle/gradle-build-action@v2
+      - name: Run build with Gradle Wrapper
+        run: ./gradlew build
+
+      - name: Upload reports for library
+        if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: library-reports (${{ matrix.os }})
+          path: binaryTree/build/reports/
+          if-no-files-found: ignore
+
+      - name: Upload reports for app
+        if: success() || failure()
+        uses: actions/upload-artifact@v3
+        with:
+          name: app-reports (${{ matrix.os }})
+          path: app/build/reports/
+          if-no-files-found: ignore
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,6 @@
+# Gradle
+.gradle
+build
+
+# Idea
+.idea
diff --git a/CONTRIBUTING.md b/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` для рефакторинга кода, например, переименования переменной
+* `perf` для изменения кода, повышающего производительность
+* `test` для добавления тестов, их рефакторинга
+* `struct` для изменений связанных с изменением структуры проекта (НО НЕ КОДА), например изменение
+  расположения папок
+* `ci` для различных задач ci/cd
+* `remove` для удаления 
+
+Поле `<scope>` опционально и показывает к какому модулю, классу, методу функции и т.п применены изменения.
+
+Поле `<body>` содержит суть изменений в повелительном наклонении настоящего времени на английском языке без точки в
+конце, первое слово - глагол с большой буквы. Текст сообщения должен включать мотивацию к изменению и контрасты с
+предыдущим поведением.
+
+Примеры:
+
+* Хорошо: "Add module for future BST implementations"
+* Плохо: "Added module for future BST implementations."
+* Плохо: "Adds module".
+* Очень плохо: "new bug."
+
+## Правила работы с ветками
+
+1. Из ветки `develop` создается ветка `release`.
+2. Из ветки `develop` создаются ветки `feature`.
+3. Когда работа над веткой `feature` завершается, она сливается в ветку `develop`.
+4. Когда работа над веткой `release` завершается, она сливается с ветками `develop` и `main`.
+5. Если в ветке `main` обнаруживается проблема, из `main` создается ветка `hotfix`.
+6. Когда работа над веткой `hotfix` завершается, она сливается с ветками `develop` и `main`.
+
+### Правила именования и создания веток `feature`
+
+Ветка под одно (большое) логическое изменение. Формат для веток `<type>/<short-body>`. Тип аналогичен тому же в
+коммитах,
+а `<short-body>` представляет собой короткое описание назначения ветки в kebab-case стиле.
+
+Примеры хороших названий:
+
+* `feat/add-avl-tree`
+* `ci/add-klint`
+
+После одобрения пулл реквеста, ветка удаляется. А новая функциональность разрабатывается в новой ветке.
+
+### Именование веток `hotfix`
+
+Формат для веток `hotfix/<short-body>`. Где `<short-body>` представляет собой короткое описание назначения ветки в
+kebab-case стиле.
+
+**Ветка `hotfix` создается только из ветки `main`**
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,16 @@
+MIT License
+
+Copyright (c) 2023 Akhmedov David, Ermolovich Anna, Efremov Alexey, 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.