MyTetra - smart crossplatform manager for information collecting / MyTetra - кроссплатформенный менеджер накопления информации / Официальная страница:
Clone or download

README.md

MyTetra - smart manager for information collecting

MyTetra is open source and cross platform personal manager for information accumulation. It is powerful program for data memorization and structuring notes.

Repository mytetra_dev

ENG: Central source repository for MyTetra development.

RUS: Основной репозитарий исходников для разработки MyTetra.

Материалы о MyTetra

Соглашение о кодировании (оформление кода)

При написании кода следует руководствоваться следующими соглашениями:

  • кодировка файлов исходников: UTF-8;

  • в коде допустимы комментарии на русском и английском языках;

  • табуляция запрещена, отступы оформляются пробелами;

  • ширина отступов - 4 пробела;

  • комментарии должны иметь тот же отступ, что и у кода;

  • название файла с реализацией класса строится по принципу: ЭтоМойКласс.cpp;

  • название файла с заголовком класса строится по принципу: ЭтоМойКласс.h;

  • название класса строится по принципу: ЭтоМойКласс;

  • название метода строится по принципу: этоМетодКласса;

  • название переменных строится по принципу: этоПеременная;

  • Открывающая "{" и закрывающая блок скобка "}" должны стоять на отдельных строчках.

  • Каждый вновь создаваемый метод должен содержать комментарий, описывающий что делает метод. Так же желательно описать назначение параметров метода;

  • В заголовочном файле класса, после секции #include необходимо в комментарии написать назначение класса.

  • Каждый заголовочный файл должен иметь следующую конструкцию:

    #ifndef _CLIPBBRANCH_H_
    #define _CLIPBBRANCH_H_
    ...
    #endif // _CLIPBBRANCH_H_
    
  • Всегда следует использовать классы и контейнеры Qt вместо классов и контейнеров STL;

  • Программа MyTetra проектируется как кроссплатформенное Qt-only приложение. Программа MyTetra не должна зависеть от сторонних библиотек, не входящих в состав Qt. Если есть необходимость воспользоваться сторонней библиотекой, включаем ее исходники в проект.

Ветки в GIT

В системе Git создано две основных ветки.

  • master - основная ветка с последним стабильным релизом;
  • experimental - ветка для разработки.

Помимо этих двух веток временно создаются другие ветки для реализации того или иного функционала. После завершения работ изменения вливаются в ветку experimental. После стабилизации изменений в experimental, изменения вливаются в master и выпускается релиз.

Решив подключиться к разработке MyTetra используйте, пожалуйста, ветку experimental для получения актуального кода.