Вклад¶

Настройка¶

git clone git@github.com/<my-github-name>/django-crispy-forms.git

pip install -r requirements.txt

pre-commit install

Build the documentation locally¶

If you make documentation changes they can be seen locally. In the directory where you cloned django-crispy-forms:

cd docs
pip install -r requirements.txt
make html

You can open the file _build/html/index.html and verify the changes.

Создание тематических веток и генерация запросов на вытягивание¶

While it’s handy to provide useful code snippets in an issue, it is better for you as a developer to submit pull requests. By submitting pull request your contribution to django-crispy-forms will be recorded by GitHub.

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

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

Also since GitHub pegs and syncs a pull request to a specific branch, it is the ONLY way that you can submit more than one fix at a time. If you submit a pull from your main branch, you can’t make any more commits to your main branch without those getting added to the pull.

Для создания ветви темы проще всего использовать удобный аргумент -b к git checkout:

git checkout -b fix-broken-thing
Switched to a new branch 'fix-broken-thing'

You should use a verbose enough name for your branch so it is clear what it is about. Now you can commit your changes and regularly merge in the upstream main branch as described below.

When you are ready to generate a pull request, either for preliminary review, or for consideration of merging into the project you must first push your local topic branch back up to GitHub:

git push origin fix-broken-thing

Now when you go to your fork on GitHub, you will see this branch listed under the «Source» tab where it says «Switch Branches». Go ahead and select your topic branch from this list, and then click the «Pull request» button.

Here you can add a comment about your branch. If this in response to a submitted issue, it is good to put a link to that issue in this initial comment. The repo managers will be notified of your pull request and it will be reviewed (see below for best practices). Note that you can continue to add commits to your topic branch (and push them up to GitHub) either if you see something that needs changing, or in response to a reviewer’s comments. If a reviewer asks for changes, you do not need to close the pull and reissue it after making changes. Just make the changes locally, push them to GitHub, then add a comment to the discussion section of the pull request.

Регулярно подтягивайте изменения из восходящего потока в свой форк¶

Над django-crispy-forms работает множество людей. Поэтому очень важно, чтобы вы регулярно переносили изменения из ствола в свой форк. Нет ничего хуже, чем вложить несколько дней напряженной работы в запрос на перенос, а потом получить отказ из-за того, что он слишком сильно отклонился от ствола.

Для внесения изменений в восходящий поток:

git remote add trunk git://github.com/django-crispy-forms/django-crispy-forms.git
git fetch trunk

Проверьте журнал, чтобы убедиться, что изменения действительно нужны, перед слиянием:

git log ..django-crispy-forms/main

Затем объедините изменения, которые вы извлекли:

git merge django-crispy-forms/main

For more info, see https://help.github.com/fork-a-repo/

Как добиться принятия вашего Pull Request¶

Нам нужны ваши предложения. Но мы также хотим обеспечить стабильный опыт для наших пользователей и сообщества. Следуйте этим правилам, и вы добьетесь успеха без проблем!

make test

pytest --ds=crispy_forms.tests.test_settings --cov=crispy_forms

>>> python -c 'import this'