1
0
mirror of https://github.com/ru-de/faq.git synced 2024-11-09 12:11:02 +00:00

contributing

This commit is contained in:
Evgeniy Sokolov 2017-01-11 22:31:14 +01:00
parent e649bfff57
commit dcc27af729

31
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,31 @@
Cпасибо, что решили помочь проекту и внести свой вклад в его развитие.
При создании Pull Request нам очень поможет, если вы будете придерживаться следующих рекомендаций:
# Какая информация приветствуется?
- Информация, которая будет отвечать на вопросы, часто возникающие у большинства вновь приехавших или собирающихся
приехать в Германию. Хорошим примером может выступать страница о [работе](https://github.com/ewgRa/de_faq/blob/master/%D0%A0%D0%B0%D0%B1%D0%BE%D1%82%D0%B0.md). Все мы так или иначе проходим через определенный круг задач, которые надо решить до приезда, по приезду и в дальнейшем: найти работу, оформить документы, найти квартиру, купить или перевезти машину, оформить BlueCard и т.д. и т.п.
- Личный опыт, позволяющий секономить время и/или деньги в каких-то ситуациях, где достижение результата подвержено каким-то субъективным факторам или не имеет четко определенной процедуры. Хороший пример - получение NE, несмотря на то, что в требуемых документах указывается необходимость сертификата A1 после 33 месяцев, известны случаи получения NE и без него.
Другим хорошим примером можно считать оформления термина в Burgeramt, когда даже если ближайших терминов нет, это еще не означает что они не появятся там через пять минут.
# Какая информация не приветствуется?
- Объемная дополнительная информация, которая уже широко представлена на других ресурсах, имеет смысл просто дать на нее ссылку и кратко описать, что там можно найти.
- Что-то очевидное и само-собой разумеющееся, информация, не отвечающая на какой-то конкретный вопрос.
# Как оформить?
- Приветствуется литературный русский язык с соблюдением пунктуации, без использования сленга. Например, вместо "тачка" лучше написать "автомобиль".
- Постарайтесь избегать эмоциональных окрасок. Вместо "очередь меня взбесила", лучше написать "придя в это время была большая очередь".
# После создания Pull Request
После создания Pull Request измененные файлы будут проверены на содержание орфографических ошибок, дождитесь пожалуйста
выполнения проверок, если какой-то check не прошел, посмотрите лог, возможно где-то допущена опечатка, либо использовано несловарное слово.
В случае если слово, на которое ругается проверка является широко употребимым, можно внести его в словарь, для этого добавьте его в файл "files/dictionary.dic"