Skip to content

Commit

Permalink
Merge pull request #35 from NikitaZotov/hotfixes
Browse files Browse the repository at this point in the history
Remove unused install deps scripts; clarify rules in CONTRIBUTING.md
  • Loading branch information
NikitaZotov authored Jan 31, 2025
2 parents fb07024 + a2cf6d1 commit d831191
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 71 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/check_style.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ 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
with:
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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test_conan.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
30 changes: 14 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <yourbranch>
Expand All @@ -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:
<pre>
[cpp] Colored log output
[cpp][test] Add unit test for ScEvent class
[scp] Implement contErase operator
[docs] Add examples of using contErase operator
</pre>

Possible tags:
Expand All @@ -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:

<pre>
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
</pre>

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:
Expand All @@ -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

Expand Down
4 changes: 0 additions & 4 deletions scripts/install_deps_macOS.sh

This file was deleted.

47 changes: 0 additions & 47 deletions scripts/install_deps_ubuntu.sh

This file was deleted.

0 comments on commit d831191

Please sign in to comment.