-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* docs: contributing guide ru lang * docs: contributing guide en lang
- Loading branch information
Alexander
authored
Aug 24, 2024
1 parent
e4c1f13
commit 4997486
Showing
2 changed files
with
65 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,34 @@ | ||
# Contributing | ||
|
||
<!--@include: ../_parts/message-not-documented.md--> | ||
First of all, thank you for choosing to contribute to the project. There are several ways to help the development of the project. | ||
|
||
## Star on GitHub | ||
|
||
The easiest thing you can do is just give us a [star on GitHub](https://github.com/hywax/shorter). It will take you a couple seconds, but it will be my pleasure! | ||
|
||
## Localization | ||
|
||
If you know a language that is not in Shorter, you can make a very valuable contribution by adding a new translation. | ||
This way a large number of people can use Shorter. Not everyone knows English. | ||
|
||
Currently, 2 languages are supported: `English`, `Russian`. You can add a new translation You can add a new translation to any of the applications: | ||
|
||
* [Shorter](https://github.com/hywax/shorter/tree/main/apps/web/app/locales) | ||
* [Documentation](https://github.com/hywax/shorter/tree/main/apps/docs) | ||
|
||
## Discussions | ||
|
||
If you know how to answer a question in [discussions](https://github.com/hywax/shorter/discussions), | ||
you will help other users a lot! Even creating your own question sometimes helps a lot. | ||
|
||
## Add features | ||
|
||
On GitHub, [issues](https://github.com/hywax/shorter/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) are created, with new features created. | ||
If you have the opportunity, you can participate in the development of the project and fulfill any issue. Or [create](https://github.com/hywax/shorter/issues/new?assignees=&labels=pending%2Cenhancement&projects=&template=enhancement.yml) your own issue. | ||
|
||
Besides tasks, there is a [roadmap](../extra/roadmap.md) of the project, by reading which you can implement new functionality. | ||
|
||
## Bug fixes | ||
|
||
Bugs are always occurring one way or another, if you encounter one in a project, [create issue](https://github.com/hywax/shorter/issues/new?assignees=hywax&labels=bug%2Cpending&projects=&template=bug-report.yaml) to fix it. | ||
If you have the opportunity, you can take any issue [from the list](https://github.com/hywax/shorter/issues?q=is%3Aissue+is%3Aopen+label%3Abug) and solve it! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,35 @@ | ||
# Внести вклад | ||
|
||
<!--@include: ../_parts/message-not-documented.md--> | ||
Прежде всего спасибо, что решили внести свой вклад в проект. Есть несколько способов помочь развитию проекта. | ||
|
||
## Звезда на Github | ||
|
||
Самое простое, что можно сделать - просто поставьте нам [звезду на Github](https://github.com/hywax/shorter). Для вас это пару секунд, но мне будет очень приятно! | ||
|
||
## Локализация | ||
|
||
Если вы знаете язык, которого нет в Shorter, то можете сделать очень ценный вклад добавив новый перевод. | ||
Тем самым большое кол-во людей могут воспользоваться Shorter. Ведь далеко не все знаю английский. | ||
|
||
На данный момент поддерживается 2 языка: `Английский`, `Русский`. Вы можете добавить новый перевод | ||
в любое из приложений: | ||
|
||
* [Shorter](https://github.com/hywax/shorter/tree/main/apps/web/app/locales) | ||
* [Документация](https://github.com/hywax/shorter/tree/main/apps/docs) | ||
|
||
## Обсуждение вопросов | ||
|
||
Если вы знаете как ответить на тот или иной вопрос в разделе [обсуждений](https://github.com/hywax/shorter/discussions), | ||
вы очень сильно поможете другим пользователям! Даже создать свой вопрос порой очень сильно помогает. | ||
|
||
## Добавление функций | ||
|
||
На GitHub создаются [задачи](https://github.com/hywax/shorter/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement), с созданием новых функций. | ||
Если у вас есть возможность, то вы можете поучаствовать в развитии проекта и выполнить любую задачу. Или [создать](https://github.com/hywax/shorter/issues/new?assignees=&labels=pending%2Cenhancement&projects=&template=enhancement.yml) собственную задачу. | ||
|
||
Помимо задач, есть [дорожная карта](../extra/roadmap.md) проекта, почитав которую вы можете реализовать новый функционал. | ||
|
||
## Исправления багов | ||
|
||
Баги так или иначе возникают всегда, если вы встретили его в проекте, то [создайте задачу](https://github.com/hywax/shorter/issues/new?assignees=hywax&labels=bug%2Cpending&projects=&template=bug-report.yaml) на исправление. | ||
Если у вас есть возможность, то вы можете взять любую задачу [из списка](https://github.com/hywax/shorter/issues?q=is%3Aissue+is%3Aopen+label%3Abug) и решить ее! |