diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e3a1bf5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,34 @@ +Спасибо, что решили помочь проекту и внести свой вклад в его развитие. + +Нам очень поможет, если при создании Pull Request вы будете придерживаться следующих рекомендаций: + +# Какая информация приветствуется? + +- Информация, которая будет отвечать на вопросы, часто возникающие у большинства вновь приехавших или собирающихся +приехать в Германию. Хорошим примером может выступать страница о [детских пособиях](https://github.com/ewgRa/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/ewgRa/de_faq/blob/master/Niederlassungserlaubnis.md#monkeyalice). Для цитирования поставьте "> " в начало строки. Текст будет выглядеть следующим образом: "> Документы почтой можно было не слать, ответ..." + + +# После создания Pull Request + +После создания Pull Request измененные файлы будут проверены роботом на содержание орфографических ошибок и недоступные ссылки, дождитесь пожалуйста +выполнения проверок, если какой-то check не прошел, посмотрите лог, возможно где-то допущена опечатка, использовано не словарное слово, либо ссылка на какую-то страницу недоступна. +В случае если слово, на которое ругается проверка является широко употребимым, можно внести его в словарь, для этого добавьте его в файл "files/dictionary.dic". +В случае если ссылка на самом деле доступна, но отдает нестандартный ответ, можно внести такой ответ как корректный в файл "files/known_url.csv" \ No newline at end of file diff --git a/files/.travis.sh b/files/.travis.sh index 42eb264..b12385d 100644 --- a/files/.travis.sh +++ b/files/.travis.sh @@ -35,13 +35,13 @@ while read FILE; do grep -Po '(?<=href=")http[^"]*(?=")' "${FILE}.html" > links if [ -s links ]; then - echo "Проверка файла $FILE на битые ссылки... "; + echo "Проверка файла $FILE на недоступные ссылки... "; while read LINK; do echo -n "Ссылка $LINK ... "; REGEXP_LINK=$(echo $LINK | sed 's/[]\.|$(){}?+*^[]/\\&/g') LINK=$(echo "$LINK" | sed -e 's/\[/\\\[/g' -e 's/\]/\\\]/g' -e 's/\&/\&/g') status=$(curl --insecure -XGET -H "User-Agent: Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/55.0.2883.87 Safari/537.36" -m 10 -L -s --head -w %{http_code} $LINK -o /dev/null) - expectedStatus=$(grep -oP "[^,]+,$REGEXP_LINK$" files/known_url.txt | cut -d',' -f1) + expectedStatus=$(grep -oP "[^,]+,$REGEXP_LINK$" files/known_url.csv | cut -d',' -f1) if [ -z "$expectedStatus" ]; then expectedStatus="200" diff --git a/files/dictionary.dic b/files/dictionary.dic index 80c7a42..1bd3360 100644 --- a/files/dictionary.dic +++ b/files/dictionary.dic @@ -1,3 +1,4 @@ +dictionary.dic постоплата Prenzlauer Berg diff --git a/files/known_url.txt b/files/known_url.csv similarity index 100% rename from files/known_url.txt rename to files/known_url.csv