faq-de/CONTRIBUTING.md

Спасибо, что решили помочь проекту и внести свой вклад в его развитие.

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

# Какая информация приветствуется?

- Информация, которая будет отвечать на вопросы, часто возникающие у большинства вновь приехавших или собирающихся 
приехать в Германию. Хорошим примером может выступать страница о [детских пособиях](https://github.com/ru-de/faq/blob/master/%D0%94%D0%B5%D1%82%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BF%D0%BE%D1%81%D0%BE%D0%B1%D0%B8%D1%8F.md). Все мы так или иначе проходим через определенный круг задач, которые надо решить до приезда, по приезду и в дальнейшем: найти работу, оформить документы, найти квартиру, купить или перевезти машину, оформить BlueCard и т.д. и т.п.
 
- Личный опыт, позволяющий сэкономить время и/или деньги в каких-то ситуациях, где достижение результата подвержено каким-то субъективным факторам или не имеет четко определенной процедуры. Хороший пример - получение NE, несмотря на то, что в требуемых документах указывается необходимость сертификата A1 после 33 месяцев, известны случаи получения NE и без него.
 Другим хорошим примером можно считать оформление термина в Burgeramt, когда даже если ближайших терминов нет, это еще не означает, что они не появятся там через пять минут.

# Какая информация не приветствуется?

- Объемная дополнительная информация, которая уже широко представлена на других ресурсах, имеет смысл просто дать на нее ссылку и кратко описать, что там можно найти.

- Что-то очевидное и само собой разумеющееся, информация, не отвечающая на какой-то конкретный вопрос.


# Как оформить?

- Приветствуется литературный русский язык с соблюдением пунктуации, без использования сленга. Например, вместо "тачка" лучше написать "автомобиль".

- Постарайтесь избегать эмоциональных окрасок. Вместо "очередь меня взбесила", лучше написать "в это время уже была большая очередь".

- Личный опыт, представленный в виде повествования, приветствуется оформлять в виде [цитаты](https://github.com/ru-de/faq/blob/master/ПМЖ.md#май-2018). Для цитирования поставьте "> " в начало строки. Текст будет выглядеть следующим образом: "> Документы почтой можно было не слать, ответ..."  


# После создания Pull Request

После создания Pull Request измененные файлы будут проверены роботом на содержание орфографических ошибок и недоступные ссылки, дождитесь пожалуйста 
выполнения проверок, если какой-то check не прошел, посмотрите лог, возможно где-то допущена опечатка, использовано не словарное слово, либо ссылка на какую-то страницу недоступна.
В случае если слово, на которое ругается проверка является широко употребимым, можно внести его в словарь, для этого добавьте его в файл "files/ci/dictionary.dic".
В случае если ссылка на самом деле доступна, но отдает нестандартный ответ, можно внести такой ответ как корректный в файл "files/ci/expected_codes.csv"
-												typos

											
										
										
											2017-01-11 23:02:58 +00:00
+								Спасибо, что решили помочь проекту и внести свой вклад в его развитие.
-												contributing

											
										
										
											2017-01-11 21:31:14 +00:00
-												fixes for review

											
										
										
											2017-01-12 12:27:59 +00:00
+								Нам очень поможет, если при создании Pull Request вы будете придерживаться следующих рекомендаций:
-												contributing

											
										
										
											2017-01-11 21:31:14 +00:00
 								# Какая информация приветствуется?
 								- Информация, которая будет отвечать на вопросы, часто возникающие у большинства вновь приехавших или собирающихся
-												move changes (#331)


											
										
										
											2018-01-02 18:28:53 +00:00
+								приехать в Германию. Хорошим примером может выступать страница о [детских пособиях](https://github.com/ru-de/faq/blob/master/%D0%94%D0%B5%D1%82%D1%81%D0%BA%D0%B8%D0%B5%20%D0%BF%D0%BE%D1%81%D0%BE%D0%B1%D0%B8%D1%8F.md). Все мы так или иначе проходим через определенный круг задач, которые надо решить до приезда, по приезду и в дальнейшем: найти работу, оформить документы, найти квартиру, купить или перевезти машину, оформить BlueCard и т.д. и т.п.
-												contributing

											
										
										
											2017-01-11 21:31:14 +00:00
-												typos

											
										
										
											2017-01-11 23:02:58 +00:00
+								- Личный опыт, позволяющий сэкономить время и/или деньги в каких-то ситуациях, где достижение результата подвержено каким-то субъективным факторам или не имеет четко определенной процедуры. Хороший пример - получение NE, несмотря на то, что в требуемых документах указывается необходимость сертификата A1 после 33 месяцев, известны случаи получения NE и без него.
-												fixes for review

											
										
										
											2017-01-12 12:27:59 +00:00
+								 Другим хорошим примером можно считать оформление термина в Burgeramt, когда даже если ближайших терминов нет, это еще не означает, что они не появятся там через пять минут.
-												contributing

											
										
										
											2017-01-11 21:31:14 +00:00
 								# Какая информация не приветствуется?
 								- Объемная дополнительная информация, которая уже широко представлена на других ресурсах, имеет смысл просто дать на нее ссылку и кратко описать, что там можно найти.
-												fixes for review

											
										
										
											2017-01-12 12:27:59 +00:00
+								- Что-то очевидное и само собой разумеющееся, информация, не отвечающая на какой-то конкретный вопрос.
-												contributing

											
										
										
											2017-01-11 21:31:14 +00:00
 								# Как оформить?
 								- Приветствуется литературный русский язык с соблюдением пунктуации, без использования сленга. Например, вместо "тачка" лучше написать "автомобиль".
-												fixes for review

											
										
										
											2017-01-12 12:27:59 +00:00
+								- Постарайтесь избегать эмоциональных окрасок. Вместо "очередь меня взбесила", лучше написать "в это время уже была большая очередь".
-												Update CONTRIBUTING.md (#633)

Fix link.
											
										
										
											2021-11-10 06:12:54 +00:00
+								- Личный опыт, представленный в виде повествования, приветствуется оформлять в виде [цитаты](https://github.com/ru-de/faq/blob/master/ПМЖ.md#май-2018). Для цитирования поставьте "> " в начало строки. Текст будет выглядеть следующим образом: "> Документы почтой можно было не слать, ответ..."
-												contributing

											
										
										
											2017-01-11 21:31:14 +00:00
 								# После создания Pull Request
-												add changes related to checks broken links

											
										
										
											2017-01-13 09:29:29 +00:00
+								После создания Pull Request измененные файлы будут проверены роботом на содержание орфографических ошибок и недоступные ссылки, дождитесь пожалуйста
 								выполнения проверок, если какой-то check не прошел, посмотрите лог, возможно где-то допущена опечатка, использовано не словарное слово, либо ссылка на какую-то страницу недоступна.
-												Github Actions for checks (#574)

* github actions ci

* github actions ci

* github actions ci

* github actions ci

* github actions ci

* github actions ci

* no deprecation

* debug

* debug

* debug

* fix

* fix

* fix

* fix

* fix

* forgotten files

* fix

* fix

* fix

* fix

* oganize everything related to ci in one folder

* add check

* fix path

* get changed files

* try this env

* expected codes file moved

* test check

* test check

* test check

* docker for local test ci and fix dict download

* local setup and some updates

* rollback

* right email
											
										
										
											2020-11-12 22:42:25 +00:00
+								В случае если слово, на которое ругается проверка является широко употребимым, можно внести его в словарь, для этого добавьте его в файл "files/ci/dictionary.dic".
-												Update CONTRIBUTING.md (#633)

Fix link.
											
										
										
											2021-11-10 06:12:54 +00:00
+								В случае если ссылка на самом деле доступна, но отдает нестандартный ответ, можно внести такой ответ как корректный в файл "files/ci/expected_codes.csv"