Files
exam/CONTRIBUTING.md
2024-11-09 23:58:17 +03:00

2.3 KiB
Raw Blame History

tags
tags
служебное

Соглашения о вкладе

Именование файлов

Все названия файлов подчиняются следующему шаблону: xx - название. Тут все стандартно как с физикой

Использование тегов

Я отхожу от своей классической практики помечать тегами только служебную информацию о заметках и даю возможность использовать предметные теги на свое усмотрение на следующих условиях:

  • Обязательно проверьте, какие теги уже существуют. Сделать это можно при помощи скрипта, который тут приложен
  • Есть небольшой набор служебных тегов, которые призваны помогать искать недоделки и недоработки

Стиль тегов

Все теги должны быть на русском языке и начинаться со строчной буквы. Слова отделяются нижними подчеркиваниями. Например (примеры обернуты чтобы они не отображались при поиске по тегам):

  • #математика
  • #русский_язык

Служебные теги

Все служебные заметки начинаются со специальной комбинации #служебное/

  • #служебное/доработать - заметка в целом закончена, но нужно внести некоторые доработки
  • #служебное/в_процессе - заметка по каким-то причинам отложена и не закончена

Эти теги служат только для передачи служебной информации о состоянии заметки

Политика каламбуров

Каждый билет должен сопровождаться каламбуром. Эти каламбуры вставляются в подложку заметки