From dcc27af729983cb022629c2651fa0fff25a9aa30 Mon Sep 17 00:00:00 2001 From: Evgeniy Sokolov Date: Wed, 11 Jan 2017 22:31:14 +0100 Subject: [PATCH] contributing --- CONTRIBUTING.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b71eba6 --- /dev/null +++ b/CONTRIBUTING.md @@ -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" \ No newline at end of file