forked from openebs/openebs
-
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.
feat(readme): add README.md & CONTRITUBING.md in Ukrainian, add CONTR…
…IBUTING.md in Russian Signed-off-by: Dmitry Danilov <daniloff200@gmail.com>
- Loading branch information
1 parent
6503c68
commit 4c517fa
Showing
8 changed files
with
239 additions
and
8 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
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 |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Как внести свой вклад в OpenEBS | ||
|
||
Прекрасно!! Мы всегда в поисках людей, которые могут улучшить OpenEBS. Вы можете начать с [обзора](./contribute/design/README.md) | ||
|
||
В первую очередь, если вы не уверены в чем-то, или побаиваетесь, все равно, задайте вопрос или же откройте issue или отправьте pull request. Вы не подвергнетесь критики за приложенные усилия. Худшее, что может произойти - вас вежливо попросят что-то изменить. Мы ценим любой вклад и не хотим создавать огромный список правил на пути к этому. | ||
|
||
Тем не менее, те, кто хочет получить более подробные рекомендации о том, как лучше всего внести свой вклад в проект, читайте дальше. Этот документ описывает все места, которые мы проверяем в ваших пулл реквестах, и увеличивает ваши шансы на быстрый мерж ваших изменений. | ||
|
||
Тем не менее, OpenEBS - это инновация в Open Source. Вы можете внести свой вклад любым возможным способом, и вся помощь, оказанная нам, очень ценится. | ||
|
||
- [Открытие issue по запросу нового функционала, фикса документации или багов](#открытие-issue) | ||
- [Предложение улучшений документации](#улучшение-документации) | ||
- [Предложение нового функционала](#предложения-нового-функционала) | ||
- [Решение сушествуюших проблем в документации или коде](#контрибьюшен-в-исходный-код-и-фикс-багов) | ||
|
||
Вот несколько простых руководств, которым нужно следовать перед тем, как отправить свой код. | ||
|
||
## Открытие issue | ||
|
||
Открывая новый issue, проверьте, что вы указали: | ||
- Условия проверки задачи должны быть заполнены, как указано в шаблонах, чтобы проверяющему было более ясен механизм проверки | ||
- Сценарий, при котором произошло issue (или понятный способ воспроизведения). | ||
- Ошибки и логи, которые были отображены. | ||
- Другие детали, которые могут быть полезны. | ||
|
||
## Улучшение документации | ||
|
||
Поддерживать документацию всегда сложно! Просмотрите эту [страницу](./contribute/CONTRIBUTING-TO-DEVELOPER-DOC.md) для более подробной информации как вы можете улучшить документацию для разработки, открыв пулл реквест с нужным тегом. Вот [список тегов](./contribute/labels-of-issues.md) которые могут быть использованы. Помогите нам содержать документацию в чистоте, легкой и доступной для понимания. | ||
|
||
## Предложения нового функционала | ||
|
||
Всегда есть что-то еще, что нужно, для удовлетворения ваших задач. Не стесняйтесь присоединиться к обсуждению новых функций или создать pull request с предложенным изменением. | ||
|
||
- [присоединяйтесь к нашему сообществу](https://openebs.io/join-our-slack-community). | ||
- Уже зарегистрированы? Присоединяйтесь к нашим обсуждениям в [# openebs-users](https://openebs-community.slack.com/messages/openebs-users/). | ||
|
||
## Контрибьюшен в исходный код и фикс багов | ||
|
||
Предоставляйте пулл реквесты с подходящими тегами для баг фиксов или улучшений исходного кода. Список тегов которые могут быть использованы есть [тут](./contribute/labels-of-issues.md). | ||
|
||
* Для контрибьюта в K8s demo, просмотрите этот [документ](./contribute/CONTRIBUTING-TO-K8S-DEMO.md). | ||
- Для информации как OpenEBS работает с K8s, просмотрите этот [документ](./k8s/README.md) | ||
- Для контрибьюта в Kubernetes OpenEBS Provisioner, просмотрите этот [документ](./contribute/CONTRIBUTING-TO-KUBERNETES-OPENEBS-PROVISIONER.md). | ||
|
||
Для информации о структуре кода и руководствах которым нужно следовать, просмотрите [этот документ](./contribute/design/code-structuring.md). | ||
|
||
## Решение существующих задач | ||
Просмотрите [issues](https://github.com/openebs/openebs/issues) дабы найти задачи где нужна помощь от участников. Посмотрите наше [руководство по меткам](./contribute/labels-of-issues.md) поможет вам найти задачи, которые вы сможете решить быстрее. | ||
|
||
Любой желающий внести свой вклад может взять задачу, попросив об этом в комментариях / назначив свой Github ID к задаче. Если в течении недели нет пулл реквеста или же каких-то обновлений о прогрессе, задача считается открытой вновь и ее может взять в работу кто угодно. В случае высокоприоритетных задач / багов обновление о статусе / прогрессе может быть нужно каждый день или два. | ||
|
||
--- | ||
### Подпишите свою работу | ||
|
||
Мы используем Developer Certificate of Origin (DCO) как дополнительную защиту для OpenEBS. Это грамотно разработанный и широкоиспользуемый механизм, позволяющий участникам подтверждать права на участие в проекте по лицензии. Пожалуйста, прочтите [developer-certificate-of-origin](./contribute/developer-certificate-of-origin). | ||
|
||
Если вы согласны на подпись, просто добавьте одну строку к каждому commit message: | ||
|
||
```` | ||
Signed-off-by: Random J Developer <random@developer.example.org> | ||
```` | ||
или используйте команду `git commit -s -m "commit message comes here"` дабы подписать коммит сразу. | ||
|
||
Используйте настоящие имя и фамилию (увы, никаких анонимов или ников). Если вы установите свои `user.name` и `user.email` в конфиге git'a , вы сможете автоматически подписать коммиты с `git commit -s`. Вы также можете использовать [алиасы](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) такие как `git config --global alias.ci 'commit -s'`. Теперь вы можете сделать коммит с `git ci` и он будет подписан. | ||
|
||
--- | ||
|
||
## Присоединяйтесь к коммьюнити! | ||
|
||
Если вы хотите активно развивать и вносить свой вклад в OpenEBS коммьюнити, просмотрите этот [документ](./community/README.md). |
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 |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# Як зробити свій внесок у OpenEBS | ||
|
||
Чудово!! Ми завжди у пошуках людей, які можуть покращити OpenEBS. Ви можете почати з [огляду](./contribute/design/README.md) | ||
|
||
Перш за все, якщо ви не впевнені в чомусь, або остерігаїтесь, все одно, задайте питання або ж відкрийте issue або ж відправте pull request. Ви не отримаєте шквал критики за прикладені зусилля. Найгірше, що може статись - вас ввічливо попросять щось змінити. Ми цінимо будь-який внесок й не хочемо создавати великий лист правил на шляху до цього. | ||
|
||
Тем не менш, ті, хто хоче отримати більш детальні рекомендації про те, як краще зробити свій внесок в проект, читайте далі. Цей документ описує усі місця, які ми перевіряємо у ваших пулл реквестах, й збільшує ваші шанси на швидкий мерж ваших змін. | ||
|
||
Тем не менш, OpenEBS - це інновація у Open Source. Ви можете внести свій внесок у будь-який можливий спосіб, та вся допомога, оказана нам, дуже цінується. | ||
|
||
- [Відкиття issue на запит нового функціоналу, фікса документації або багів](#відкриття-issue) | ||
- [Пропозиції щодо покращення документації](#покращення-документації) | ||
- [Пропозиції щодо нового функціоналу](#пропонування-нового-функціоналу) | ||
- [Вирішення існуючих проблем у документації або коді](#контриб'ют-у-початковий-код-й-фікс-багів) | ||
|
||
Ось декілька простих пунктів, яким потрібно прямувати перед тим,як відправляти свій код. | ||
|
||
## Відкриття issue | ||
|
||
Відкриваючи новий issue, перевірте, що ви вказали: | ||
- Умови перевірки задач мають бути заповнені, як вказано у шаблонах, щоб перевіряючому був яснішим механизм перевірки. | ||
- Сценарій, при якому сталося issue (або зрозумілий спосіб відтворення). | ||
- Помилки та логи, які можуть бути відображені. | ||
- Інші деталі, що можуть бути корисними. | ||
|
||
## Покращення документації | ||
|
||
Підтримувати документацію завжди важко! Продивиться цю [сторінку](./contribute/CONTRIBUTING-TO-DEVELOPER-DOC.md) для більш подробної інформації як ви можете покращити документацію для розробки, відкривши пулл реквест с потрібним тегом. Ось [лист тегів](./contribute/labels-of-issues.md) які можуть бути використані. Допоможіть нам тримати документацію чистою, легкою й доступною для розуміння. | ||
|
||
## Пропонування нового функціоналу | ||
|
||
Завжди є ще щось, що потрібно, для задоволення ваших потреб. Не бійтесь приєднатись до обговорень нового функціоналу або зробити pull request з запропонованими змінами. | ||
|
||
- [Приєднуйтесь до нашого товариства](https://openebs.io/join-our-slack-community). | ||
- Вже зареєстровані? Приєднуйтесь до наших обговорень в [# openebs-users](https://openebs-community.slack.com/messages/openebs-users/). | ||
|
||
## Контриб'ют у початковий код й фікс багів | ||
|
||
Створюйте рулл реквести з відповідними тегами для фіксів багів або покращень початкового коду. Лист тегів які можуть бути використані [тут](./contribute/labels-of-issues.md). | ||
|
||
* Для контриб'юту у K8s demo, дивиться цей [документ](./contribute/CONTRIBUTING-TO-K8S-DEMO.md). | ||
- Для інформації як OpenEBS працює з K8s, дивиться цей [документ](./k8s/README.md) | ||
- Для контриб'юту у Kubernetes OpenEBS Provisioner, дивиться цей [документ](./contribute/CONTRIBUTING-TO-KUBERNETES-OPENEBS-PROVISIONER.md). | ||
|
||
Для інформації о структурі коду й інструкціях, які потрібно виконувати, дивиться [цей документ](./contribute/design/code-structuring.md). | ||
|
||
## Робота над існуючими задачами | ||
Продивиться [issues](https://github.com/openebs/openebs/issues) щоб знайти задачі де нужна допомога від учасників. Подивиться нашу [вказівку з міток](./contribute/labels-of-issues.md) яка допоможе вам знайти задачі, які ви зможете вирішити швидше. | ||
|
||
Будь хто може внести свій внесок, взявши задачу, попросивши про це у комментарях / назначивши свій Github ID до задачі. Якщо протягом тижня немає пулл реквеста або ж будь яких оновлень щодо прогрессу, задача вважається відкритою знову і її може взяти до роботи хто завгодно. У випадку задач з високим пріорітетом / багів оновлення про статус / прогрес може бути необхідним кожен день або два. | ||
|
||
--- | ||
### Підпишить свою роботу! | ||
|
||
Ми використовуємо Developer Certificate of Origin (DCO) як додатковий захист для OpenEBS. Це добре розроблений й широковикористовуємий механизм, що дозволяє учасникам підтвердити права на участь у проекті згідно лицензії. Будь ласка, прочитайте [developer-certificate-of-origin](./contribute/developer-certificate-of-origin). | ||
|
||
Якщо ви згодні на підпис, лише додайте одну строку к кожному commit message: | ||
|
||
```` | ||
Signed-off-by: Random J Developer <random@developer.example.org> | ||
```` | ||
або використайте команду `git commit -s -m "commit message comes here"` щоб підписати комміт одразу. | ||
|
||
Використовуйте справжні ім'я й прізвище (нажаль, ніяких анонимів або ніків). Якщо ви встановите свої `user.name` та `user.email` у конфигу git'a , ви зможете автоматично підписати коміти з `git commit -s`. Ви також можете використовувати [аліаси](https://git-scm.com/book/en/v2/Git-Basics-Git-Aliases) такі як `git config --global alias.ci 'commit -s'`. Тепер ви можете зробити коміт с `git ci` і він буде підписаним. | ||
|
||
--- | ||
|
||
## Приєднуйтесь до ком'юніті! | ||
|
||
Якщо ви хочете активно розвивати й вносити свій внесок у OpenEBS ком'юніті, подивиться цей [документ](./community/README.md). |
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
Oops, something went wrong.