Внесение вклада

Привет!

Спасибо за интерес к Parsley и желание внести свой вклад. Добро пожаловать!

Прежде всего: убедитесь, что вы используете последнюю официальную версию.

Вопросы?

Пожалуйста, задавайте вопросы на StackOverflow и обязательно добавьте тег parsley.js. Пожалуйста, предоставьте пример, начиная, например, с этого jsfiddle.

Проблемы?

Если вы считаете, что обнаружили ошибку в Parsley, пожалуйста, предоставьте пример, начиная, например, с этого jsfiddle.

Это позволит вам убедиться, что проблема сведена к минимальному случаю. Это также значительно облегчит нам понимание вашей проблемы. Иногда проблема оказывается совершенно иной, чем вы ожидаете, и только реальный пример может привести к решению.

Запросы на вытягивание?

Чтобы запустить тесты локально:

npm install	          # нужно только в самый первый раз!
gulp test             # запускает тесты в консоли
# или чтобы запустить их в браузере:
gulp test-browser    	# запускает локальный сервер
open test/runner.html # открыть в вашем любимом браузере

Примечание: Parsley написан на EcmaScript 6.

Примечание: В настоящее время есть тест, который не проходит на некоторых системах. Пиво вам, если вы сможете это исправить, см. https://github.com/guillaumepotier/Parsley.js/issues/1095

Дополнительные советы для любых проектов с открытым исходным кодом

Вот несколько простых правил, которые вам придётся соблюдать, чтобы облегчить проверку кода, обсуждения и слияние PR.

1. Вы ДОЛЖНЫ следовать стандарту кодирования Parsley. Он в основном следует этим популярным правилам, за исключением того, что функции следуют за одним пробелом в Parsley. Используйте два пробела в качестве табуляции.

2. Вы ДОЛЖНЫ писать / обновлять тесты для каждого вклада кода, который вы делаете.

3. Вы ДОЛЖНЫ зафиксировать проходящий набор тестов.

4. Вам СЛЕДУЕТ написать документацию.

5. Вы НЕ ДОЛЖНЫ изменять /dist. Изменения вносятся только в /src, /test и т. д.

Пожалуйста, пишите сообщения о фиксации, которые имеют смысл, и перебазируйте свою ветку перед отправкой запроса на вытягивание.

Вас могут попросить сквошить ваши коммиты тоже. Это используется для «очистки» вашего запроса на вытягивание перед его объединением (мы не хотим коммитов типа fix tests, fix 2, fix 3 и т.д.). Хорошее эмпирическое правило: набор тестов должен проходить в каждой точке фиксации.

Также при создании запроса на вытягивание на GitHub вы ДОЛЖНЫ написать описание, которое даёт контекст и/или объясняет, почему вы его создаёте.

Спасибо!

Вдохновлено http://williamdurand.fr/2013/07/04/on-open-sourcing-libraries/