Skip to content
This repository was archived by the owner on Nov 19, 2023. It is now read-only.

Commit 1f7a892

Browse files
authored
chore: update contributing
1 parent b729c9e commit 1f7a892

File tree

1 file changed

+1
-49
lines changed

1 file changed

+1
-49
lines changed

.github/CONTRIBUTING.md

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1 @@
1-
# И так, вы хотите начать помогать с разработкой
2-
3-
Тут собрано всё что нужно для того чтобы начать вносить вклад в проект
4-
5-
# Стэк
6-
7-
Для начала вы должны ознакомиться с активным стеком приложения, все пункты расположены в порядке важности, пунты помеченные "**\[?\]**" являются необязательными
8-
9-
* TypeScript 4.7+
10-
* React 18 (html, css, es2022)
11-
* MobX (ООП)
12-
* Styled-components
13-
* **\[?\]** Rust
14-
15-
# Настройка окружения
16-
17-
Выполните настройку окружения по [этому](https://tauri.app/v1/guides/getting-started/prerequisites) гайду.
18-
Далее форкните и клонируйте себе [репозиторий](https://github.com/NodiumMC) проекта. Клонировать нужно свой форк.
19-
20-
# Ознакомьтесь с картой проекта
21-
22-
*скоро...*
23-
24-
# Соглашение о коммитах
25-
26-
Все коммиты **ДОЛЖНЫ** быть подписаны и соответствовать [соглашению о коммитах](https://www.conventionalcommits.org/ru/v1.0.0/)
27-
28-
### TL; DR
29-
30-
* `feat: message` - Используйте для фич. Исключайте наличие слов **add** или перечисления
31-
* `fix: message` - Используйте только для исправлений. Исключайте перечисления.
32-
* `chore(...)` - Используйте для изменений не влияющих на поведение приложения. Например `chore(deps): Update dependency x to 2.0.0` для обновления зависимостей.
33-
* `style: message` - Используйте для форматирования кода или стиля кода. Такие как `eslint` или `prettier`.
34-
35-
### Уточняйте наиболее незначительные и частые изменения
36-
37-
`feat(i18n): message` или `fix(i18n): message` - Для перевода и исправления перевода соответственно
38-
39-
# Начните разработку
40-
41-
Создайте под вашу фичу или фикс подходящую ветку с говорящим названием. Например: `fix-minecraft-launching` или `add-store-subscreen`. Старайтесь не смешивать фичи в одной ветке.
42-
43-
# Создайте Pull Request
44-
45-
Как только фича готова и протестирована лично вами, создайте PR в основном [репозитории](https://github.com/NodiumMC/launcher). В названии PR должна быть общая суть вашей работы, а все детали в описании, можно на русском языке. Например: `Авторизация Nodium ID`.
46-
47-
# Вливание изменений
48-
49-
Если ваш PR одобрят, то ваши изменения вскоре попадут в ближайший релиз.
1+
# [Read on Notion](https://ndml.notion.site/Contributing-32cfc76a7fc2434bbfd3465f441e5024)

0 commit comments

Comments
 (0)