Skip to content

Commit

Permalink
DOCS: add a semantic commit messages disclaimer
Browse files Browse the repository at this point in the history
* docs: update invalid RPC docs link

* docs: add Discord widget from shields.io

* docs: add a disclaimer about semantic commit messages technique in CONTRIBUTING.md

* docs: add a disclaimer about semantic commit messages to the web docs

* docs: add semantic sommits sections to the CONTRIBUTING ru

---------

Co-authored-by: Pastukhov Nikita <diementros@yandex.ru>
  • Loading branch information
kolkre and Lancetnik committed Jul 30, 2023
1 parent 745c223 commit 58e2a11
Show file tree
Hide file tree
Showing 4 changed files with 102 additions and 0 deletions.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,39 @@

If you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.

### Commits

When making commits, use semantic commit messages system.

Format: `<type>(<scope>): <subject>`

Where `<scope>` is optional.

```
feat: add synchronous RabbitMQ wrapper
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
```

More Examples:

- `feat`: (New feature for the user, not a new feature for build script)
- `fix`: (Bug fix for the user, not a fix to a build script)
- `docs`: (Changes to the documentation)
- `style`: (Formatting, linting)
- `refactor`: (Refactoring code, eg. renaming a variable)
- `test`: (Adding missing tests, refactoring tests)
- `chore`: (Updating grunt tasks etc.)

References:

- https://www.conventionalcommits.org/
- https://sparkbox.com/foundry/semantic_commit_messages
- http://karma-runner.github.io/1.0/dev/git-commit-msg.html

### Virtual environment with `venv`

You can create a virtual environment in a directory using Python's `venv` module:
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@
<a href="https://github.com/Lancetnik/Propan/blob/main/LICENSE" target="_blank">
<img alt="GitHub" src="https://img.shields.io/github/license/Lancetnik/Propan?color=%23007ec6">
</a>
<a href="https://discord.gg/ChhMXJpvz7" target="_blank">
<img alt="Discord" src="https://img.shields.io/discord/1122560426794831872?logo=discord">
</a>
</p>

# Propan
Expand Down
33 changes: 33 additions & 0 deletions docs/docs/en/contributing/2_contributing-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,39 @@

If you already cloned the repository and you know that you need to deep dive in the code, here are some guidelines to set up your environment.

### Commits

When making commits, use semantic commit messages system.

Format: `<type>(<scope>): <subject>`

Where `<scope>` is optional.

```
feat: add synchronous RabbitMQ wrapper
^--^ ^------------^
| |
| +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.
```

More Examples:

- `feat`: (New feature for the user, not a new feature for build script)
- `fix`: (Bug fix for the user, not a fix to a build script)
- `docs`: (Changes to the documentation)
- `style`: (Formatting, linting)
- `refactor`: (Refactoring code, eg. renaming a variable)
- `test`: (Adding missing tests, refactoring tests)
- `chore`: (Updating grunt tasks etc.)

References:

- https://www.conventionalcommits.org/
- https://sparkbox.com/foundry/semantic_commit_messages
- http://karma-runner.github.io/1.0/dev/git-commit-msg.html

### Virtual environment with `venv`

You can create a virtual environment in a directory using Python's `venv` module:
Expand Down
33 changes: 33 additions & 0 deletions docs/docs/ru/contributing/2_contributing-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,39 @@

Если вы уже склонировали репозиторий и уверены, что хотите погрузить в код, вам пригодятся эти гайдлайны для настройки окружения.

### Commits

Когда вы делаете коммиты, пожалуйста, используйте соглашение о семантическом именовании.

Формат: `<type>(<scope>): <subject>`

Где `<scope>` необязателен.

```
feat: add synchronous RabbitMQ wrapper
^--^ ^------------^
| |
| +-> Краткое именование
|
+-------> Типы: chore, docs, feat, fix, refactor, style, or test.
```

Больше примеров:

- `feat`: (Новый функционал для пользователей)
- `fix`: (Багфикс в рамках функционала)
- `docs`: (Изменения в документации)
- `style`: (Formatting, linting)
- `refactor`: (Рефакторинг кода, например изменение названий переменных)
- `test`: (Добавление или рефакторинг тестов)
- `chore`: ("обслуживающие" коммиты - повышение версии, апдейт зависимостей и т.д.)

Материалы по теме:

- https://www.conventionalcommits.org/
- https://sparkbox.com/foundry/semantic_commit_messages
- http://karma-runner.github.io/1.0/dev/git-commit-msg.html

### Создайте окружение `venv`

Как и любой *python* проект, **Propan** лучше разрабатывать в отдельном окружении.
Expand Down

0 comments on commit 58e2a11

Please sign in to comment.