|
| 1 | +# Добро пожаловать в руководство по внесению вклада в репозиторий для подготовки к сдаче экзамена по предмету "Алгоритмы и анализ сложности" (2-ой курс) |
| 2 | + |
| 3 | +Спасибо, что вложили своё время в улучшение этого репозитория! Любой ваш вклад будет полезен, ведь он возможно сможет помочь при подготовки к экзамену следующему поколению студентов. :sparkles: |
| 4 | + |
| 5 | +## Ваш вклад может быть |
| 6 | +- Сообщение об опечатках в коде или в тексте описания алгоритмов; |
| 7 | +- Исправление ошибок в коде алгоритма; |
| 8 | +- Исправление ошибок в описание алгоритма; |
| 9 | +- Предложение альтернативной реализации алгоритма; |
| 10 | +- Предложение альтернативного описания алгоритма; |
| 11 | +- Добавление нового билета (в случае изменения требований на экзамене); |
| 12 | + |
| 13 | +## Все изменения в репозиторий происходят через запросы на включения (Pull Requests) |
| 14 | + |
| 15 | +1. Сделайте Fork репозитория и создайте свою ветку из ветки main. |
| 16 | +2. Если вы вносите изменения в описание, то не забудьте убедиться в правильности вашего описания по сторонним источникам. |
| 17 | +3. Если вы вносите изменения в код, то убедитесь, что код работает и соответствует алгоритму. |
| 18 | +4. Отправьте запрос, но не забудьте добавить ссылки на используемы источники, чтобы можно было убедиться в правильности написанного. |
| 19 | + |
| 20 | +## Любые вклады, которые вы делаете, будут находиться под лицензией на программное обеспечение [MIT](./LICENSE) |
| 21 | + |
| 22 | +То есть, когда вы отправляете свои изменения в репозиторий, считается, что ваши изменения находятся под той же [лицензией MIT](./LICENSE), которая распространяется на проект. |
| 23 | + |
| 24 | +**Разрешения:** |
| 25 | + |
| 26 | +- Коммерческое использование; |
| 27 | +- Модификации; |
| 28 | +- Распространение; |
| 29 | +- Приватное использование; |
| 30 | + |
| 31 | +**Ограничения:** |
| 32 | + |
| 33 | +- Не несу ответственности; |
| 34 | +- Не даю гарантию; |
| 35 | + |
| 36 | +## Пишите отчеты об ошибках с подробным описанием и примером кода. |
| 37 | +**Отчёт может содержать:** |
| 38 | + |
| 39 | +- Краткое резюме и/или предыстория; |
| 40 | +- Ссылки на используемые источники (непосредственно те, если они есть, откуда взят добавляемый материал); |
| 41 | +- Указание того что сейчас есть (в описание или в коде) и, что вы ожидаете увидеть; |
| 42 | +- Возможно, примеры не пройденных тестов для кода алгоритма; |
| 43 | +- Какие-то дополнительные ваши замечания/рассуждения алгоритму; |
| 44 | + |
| 45 | +## Используйте согласованный стиль кодирования |
| 46 | +Предполагается, что в репозитории к алгоритмам приводятся примеры реализаций на C#. Если требования к сдаче экзамена изменились, то допускается добавления реализаций алгоритмов на других одобренных преподавателем языках программирования. |
| 47 | + |
| 48 | +Перед тем как отправлять запрос, вы должны убедиться, что написанный вами код соответствует базовым нормам стиля кодирования на том или ином языке. |
| 49 | + |
| 50 | +[Пример](https://www.elma-bpm.ru/KB/article-6651.html) стандарта написания программного кода на языке C#. |
| 51 | + |
| 52 | +## Лицензия |
| 53 | +Внося свой вклад, вы соглашаетесь с тем, что ваши вклады будут лицензироваться в соответствии с лицензией [MIT](./LICENSE). |
0 commit comments