diff --git a/.github/workflows/check_style.yml b/.github/workflows/check_style.yml index 9c5ffc6..d66557d 100644 --- a/.github/workflows/check_style.yml +++ b/.github/workflows/check_style.yml @@ -50,7 +50,7 @@ jobs: uses: actions/cache@v4 with: path: ~/.conan/data - key: check-style-${{ runner.os }}-${{ hashFiles('**/conanfile.py') }} + key: conan-${{ runner.os }}-${{ hashFiles('**/conanfile.py') }} - name: apt cache uses: actions/cache@v4 @@ -58,7 +58,7 @@ jobs: path: | /var/cache/apt/ /var/lib/apt/ - key: apt-${{ runner.os }}-${{ github.job }}-${{ hashFiles('**/install_deps_ubuntu.sh') }} + key: apt-${{ runner.os }}-${{ github.job }} - name: Set up Python uses: actions/setup-python@v4 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8055220..50b4687 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -44,7 +44,7 @@ jobs: path: | /var/cache/apt/ /var/lib/apt/ - key: apt-${{ runner.os }}-${{ github.job }}-${{ hashFiles('**/install_deps_ubuntu.sh') }} + key: apt-${{ runner.os }}-${{ github.job }} - name: Set up Python uses: actions/setup-python@v4 diff --git a/.github/workflows/test_conan.yml b/.github/workflows/test_conan.yml index 88b2993..087d662 100644 --- a/.github/workflows/test_conan.yml +++ b/.github/workflows/test_conan.yml @@ -40,7 +40,7 @@ jobs: path: | /var/cache/apt/ /var/lib/apt/ - key: apt-${{ runner.os }}-${{ github.job }}-${{ hashFiles('**/install_deps_ubuntu.sh') }} + key: apt-${{ runner.os }}-${{ github.job }} - name: Set up Python uses: actions/setup-python@v4 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3f9a2cd..c66c4e1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,7 @@ This page describes rules to contribute changes and features by Pull Requests cr To initialize your repo do: -* Make fork from `https://github.com/ostis-ai/scp-machine`. +* Fork `https://github.com/ostis-ai/scp-machine`. * Clone your fork to your machine and prepare (see [Readme](https://github.com/ostis-ai/scp-machine)). ```sh @@ -20,8 +20,7 @@ git fetch upstream git checkout upstream/main ``` -* Use `git rebase` instead of `merge`. [More documentation about this command](https://git-scm.com/docs/git-rebase) -just try to apply your commits (from current branch to commits in specified branch). To rebase your branch to main use: +* Use `git rebase` instead of `merge`. See [documentation about this command](https://git-scm.com/docs/git-rebase). To rebase your branch against main use: ```sh git checkout @@ -40,13 +39,12 @@ git rebase --abort Each commit message should be formed as: `[tag1]...[tagN] Message text (#issue)`. -Message text should start from an upper case letter. If commit doesn't fix or implement any #issue, then it shouldn't -be pointed in commit message. +Message text should start from an upper case letter. If commit doesn't fix or implement any #issue, then it shouldn't be pointed in commit message. Examples:
-[cpp] Colored log output
-[cpp][test] Add unit test for ScEvent class
+[scp] Implement contErase operator 
+[docs] Add examples of using contErase operator
 
Possible tags: @@ -63,18 +61,18 @@ Possible tags: * `[ci]` - changes in `ci` configuration or scripts; * `[git]` - changes in `git` configuration; -Each commit in Pull Request should be an atomic. Another word implement or fix one feature. For example: +Each commit in Pull Request should be an atomic. In other words, it should implement or fix one feature. For example: +
 Last commit
 ...
-[cpp] Colored log output
-[cpp] Add class to work with console
+[tests] Test contErase operator
+[changelog] Add info about contErase operator
 ...
 Init commit
 
-In this example we add class to work with console (where implemented colored output), then in another commit we had -implementation of colored log output. +In this example we add class to work with console (where implemented colored output), then in another commit we add gimplementation of colored log output. *** Each commit should have not much differences excluding cases, with: @@ -91,14 +89,14 @@ Each commit should have not much differences excluding cases, with: **Do not mix codestyle changes and any logical fixes in one commit.** -All commit, that not applies to this rules, should be split by this rules. Another way they will be rejected with Pull request. +All commits that not follow these rules should be split according to these rules. Otherwise they will be rejected with Pull Request. *** -## Pull request +## Pull Request -Each pull request with many changes, that not possible to review (excluding codestyle, rename changes), will be rejected. +Each Pull Request with many changes, that not possible to review (excluding codestyle, rename changes), will be rejected. -_**All commit, that not applies to these rules, should be split by these rules. Another way they will be rejected with Pull request.**_ +_**All commit, that not applies to these rules, should be split by these rules. Another way they will be rejected with Pull Request.**_ ### Pull Request Preparation diff --git a/scripts/install_deps_macOS.sh b/scripts/install_deps_macOS.sh deleted file mode 100755 index 379696a..0000000 --- a/scripts/install_deps_macOS.sh +++ /dev/null @@ -1,4 +0,0 @@ -#!/usr/bin/env bash -set -eo pipefail - -brew install googletest diff --git a/scripts/install_deps_ubuntu.sh b/scripts/install_deps_ubuntu.sh deleted file mode 100755 index cd15d41..0000000 --- a/scripts/install_deps_ubuntu.sh +++ /dev/null @@ -1,47 +0,0 @@ -#!/usr/bin/env bash -set -eo pipefail - -function usage() { - cat < /dev/null 2>&1; -then - RED='\033[22;31m' - NC='\033[0m' # No Color - echo -e "${RED}[ERROR] Apt command not found. Debian-based distros are the only officially supported. -Please install the following packages by yourself: - ${packages[*]} - ${NC}" - exit 1 -fi -sudo apt-get update && sudo apt-get install -y --no-install-recommends software-properties-common -sudo add-apt-repository -y universe -sudo apt-get update -sudo apt-get install -y --no-install-recommends "${packages[@]}" -sudo apt autoremove