Прежде чем принять участие в разработке проекта, ознакомьтесь с правилами разработки. Разработка может состоять, но не ограничивается сообщениями о проблемах, написанием документации и собственно процесса разработки. Ниже приведены указания, которые регулируют каждую из составляющих процесса разработки.
- Поискать проблему в уже сообщённых.
- Текст сообщения писать на русском, украинском или английском языках.
- Если проблема — это баг-репорт, то следовать структуре, приведённой в примере баг-репорта.
- Следовать стандартам написания кода.
- Давать веткам, которые используются для разработки, осмысленные имена. Например,
issue-53— правильное имя ветки с решением проблемы;abc1— неправильное название в подавляющем большинстве случаев. - Если ветка решает одну из существующих проблем, следует указывать это в названии ветки. Например, если ветка решает проблему №53, её название должно иметь такой вид:
Handle IOError when database file is not found. (Closes #53) - Оставлять осмысленные сообщения к коммитам. Например,
Add IOError exception handling in load_file()— правильно;Add more fixes— неправильно.
- Для решения определённой проблемы (issue) можно создать Merge Request непосредственно на веб-странице, в которой она описана, с помощью кнопки «Create a merge request».
- Писать черновики документации в формате Markdown, и называть документ соответствующим образом. Например, черновик тест-плана должен быть назван
test-plan.md. - Следовать стандартам написания кода, в которых также содержатся сведения по оформлению документации.
- Следовать рекомендованному процессу написания:
- Написание черновика в формате Markdown.
- Написание разметочного файла в системе (XeLa)TeX.
- Компиляция разметочного файла в PDF-файл.