diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..1453b40 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +--- +tags: + - служебное +--- +# Соглашения о вкладе + +## Использование тегов + +Я отхожу от своей классической практики помечать тегами служебную информацию о заметках и даю возможность использовать предметные теги на свое усмотрение на следующих условиях: + +- Обязательно проверьте, какие теги уже существуют. Сделать это можно при помощи скрипта, который тут приложен +- Есть небольшой набор служебных тегов, которые призваны помогать искать недоделки и недоработки + +### Стиль тегов + +Все теги должны быть на **русском** языке и начинаться со *строчной* буквы. Слова отделяются нижними подчеркиваниями. Например (примеры обернуты чтобы они не отображались при поиске по тегам): + +- `#математика` +- `#русский_язык` + +### Служебные теги + +Все служебные заметки начинаются со специальной комбинации `#служебные/` + +- #служебное/доработать - заметка в целом закончена, но нужно внести некоторые доработки +- #служебное/в_процессе - заметка по каким-то причинам отложена и не закончена +- #служебное - тег, которым помечаются все служебные заметки + +Эти теги служат только для передачи служебной информации о состоянии заметки + +## Политика каламбуров + +Каждый билет должен сопровождаться каламбуром. Эти каламбуры вставляются в подложку заметки diff --git a/README.md b/README.md index f5d97ad..5bfde7b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Билеты к архитектурам комьпютера +# Билеты к архитектурам компьютера ## Что это @@ -8,3 +8,7 @@ Эти билеты пишутся так, чтобы их легко мог прочитать obsidian. В будущем возможно добавлю сборку в PDF если мне будет нечего делать +### Примечание + +Замечу, что содержимое основных вопросов от 2022 года отличается от содержимого билетов за 2023 год. Но так как ничего свежее нет, пишем по 2022 году, а там если что подправлю +