From 1ae1fc875c36fa7025564f8dc5ddc5ba3ff127cb Mon Sep 17 00:00:00 2001 From: Xikaro Date: Mon, 25 Aug 2025 02:24:53 +0500 Subject: [PATCH] fix: CONTRIBUTING.md --- .github/CONTRIBUTING.md | 20 ++++++++++++++++---- .github/workflows/build.yml | 15 +++++++-------- 2 files changed, 23 insertions(+), 12 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e72ae8188..e45d49669 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -83,14 +83,14 @@ 3. Select Minecraft version **`1.20.1`** and Forge version **`47.2.6`** — these versions are necessary for the modpack to work correctly. > [!TIP] -> ![Interface for creating a new instance in PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/guide/new_instances.png?raw=true) +> ![Interface for creating a new instance in PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/wiki/new_instances.png?raw=true) #### Step 3: Cleaning the Project Folder 1. Locate the instance folder in the PrismLauncher directory at **`TerraFirmaGreg-Modern/minecraft`**. > [!TIP] > For quick access, right-click on the instance and select **`Folder`**. -> ![Instance folder in PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/guide/prism_folder.png?raw=true) +> ![Instance folder in PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/wiki/prism_folder.png?raw=true) > [!WARNING] > Delete all files and directories inside the `minecraft` folder to avoid version conflicts and leftover old data. @@ -237,6 +237,12 @@ There are two approaches to creating a Pull Request: via terminal and via GitHub ### 3. Additional Recommendations +- #### Semantic Versioning Rules: + - The project follows [Semantic Versioning](https://semver.org/). + - **Patch**: Bug fixes and small changes (`1.0.0` → `1.0.1`) + - **Minor**: New features that don't break compatibility (`1.0.0` → `1.1.0`) + - **Major**: Breaking changes (`1.0.0` → `2.0.0`) + - #### Working with Git: - Create separate branches for each new functionality or bug fix. - Regularly synchronize your fork with the original repository to avoid conflicts. @@ -316,14 +322,14 @@ There are two approaches to creating a Pull Request: via terminal and via GitHub 3. Выберите версию Minecraft **`1.20.1`** и версию **`Forge 47.2.6`** — именно эти версии необходимы для корректной работы модпака. > [!TIP] -> ![Интерфейс для создания новой инстанции в PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/guide/new_instances.png?raw=true) +> ![Интерфейс для создания новой инстанции в PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/wiki/new_instances.png?raw=true) #### Шаг 3: Очистка папки проекта 1. Найдите папку инстанции в директории PrismLauncher по пути **`TerraFirmaGreg-Modern/minecraft`**. > [!TIP] > Для быстрого доступа нажмите правой кнопкой по инстанции и выберите **`Folder`**. -> ![Папка инстанции в PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/guide/prism_folder.png?raw=true) +> ![Папка инстанции в PrismLauncher](https://github.com/TerraFirmaGreg-Team/.github/blob/main/wiki/prism_folder.png?raw=true) > [!WARNING] > Удалите все файлы и каталоги внутри папки `minecraft`, чтобы избежать конфликтов версий и остатков старых данных. @@ -470,6 +476,12 @@ There are two approaches to creating a Pull Request: via terminal and via GitHub ### 3. Дополнительные рекомендации +- #### Правила семантического версионирования: + - The project follows [Semantic Versioning](https://semver.org/). + - **Patch**: Исправлены ошибки и небольшие изменения (`1.0.0` → `1.0.1`) + - **Minor**: Новые функции, которые не нарушают совместимость (`1.0.0` → `1.1.0`) + - **Major**: Критические изменения (`1.0.0` → `2.0.0`) + - #### Работа с Git: - Создавайте отдельные ветки для каждой новой функциональности или исправления ошибок. - Регулярно синхронизируйте свой форк с оригинальным репозиторием для избежания конфликтов. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c13eacce5..7c6458772 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -284,8 +284,8 @@ jobs: ${{ needs.info.outputs.changelog }} - build-modpack: - name: 📦 Build Modpack + build-project: + name: 📦 Build Project needs: [info] runs-on: ubuntu-latest steps: @@ -357,8 +357,7 @@ jobs: - name: 📁 Preparing the artifact multimc run: | - mkdir -p .pakku/multimc-overrides/flame - mkdir -p .pakku/multimc-overrides/mods + mkdir -p .pakku/multimc-overrides/flame .pakku/multimc-overrides/mods mv -vf .pakku/multimc-overrides ./build/multimc @@ -391,7 +390,7 @@ jobs: release-github: name: 🚀 Release to GitHub - needs: [info, build-modpack] + needs: [info, build-project] runs-on: ubuntu-latest if: ${{ needs.info.outputs.make_release == 'true' }} outputs: @@ -454,7 +453,7 @@ jobs: release-curseforge: name: 🚀 Release to CurseForge - needs: [info, build-modpack, release-github] + needs: [info, build-project, release-github] runs-on: ubuntu-latest if: ${{ needs.info.outputs.make_release == 'true' }} outputs: @@ -504,7 +503,7 @@ jobs: release-modrinth: name: 🚀 Release to Modrinth - needs: [info, build-modpack, release-github] + needs: [info, build-project, release-github] runs-on: ubuntu-latest if: false outputs: @@ -552,7 +551,7 @@ jobs: discord-message: name: 📱 Discord Message - needs: [info, release-curseforge, release-github] + needs: [info, release-github, release-curseforge] runs-on: ubuntu-latest steps: - name: ✂️ Truncate Changelog