Core committers, use this section to:
Being extendable by people with different ideas for Jinja2-based project template tools.
Freedom for Cookiecutter users to build and extend.
Cookiecutter is designed to do one thing, and do that one thing very well.
Cookiecutter project templates are intentionally hosted VCS repos as-is.
If a pull request is untriaged:
How to prioritize pull requests, from most to least important:
Ensure that each pull request meets all requirements in this checklist: https://gist.github.com/audreyr/4feef90445b9680475f2
If an issue is a bug that needs an urgent fix, mark it for the next patch release. Then either fix it or mark as please-help.
For other issues: encourage friendly discussion, moderate debate, offer your thoughts.
New features require a +1 from 2 other core committers (besides yourself).
The roadmap is https://github.com/audreyr/cookiecutter/milestones?direction=desc&sort=due_date&state=open
Due dates are flexible. Core committers can change them as needed. Note that GitHub sort on them is buggy.
How to number milestones:
Milestone size:
If you merge a pull request, you’re responsible for updating AUTHORS.rst and HISTORY.rst
When you’re processing the first change after a release, create boilerplate following the existing pattern:
The goals of this release are TODO: release summary of features
Features:
- Feature description, thanks to @contributor (#PR).
Bug Fixes:
- Bug fix description, thanks to @contributor (#PR).
Other changes:
- Description of the change, thanks to @contributor (#PR).
From the cookiecutter project root:
$ make contributing
This will generate the following message:
rm CONTRIBUTING.rst
touch CONTRIBUTING.rst
cat docs/contributing.rst >> CONTRIBUTING.rst
echo "\r\r" >> CONTRIBUTING.rst
cat docs/types_of_contributions.rst >> CONTRIBUTING.rst
echo "\r\r" >> CONTRIBUTING.rst
cat docs/contributor_setup.rst >> CONTRIBUTING.rst
echo "\r\r" >> CONTRIBUTING.rst
cat docs/contributor_guidelines.rst >> CONTRIBUTING.rst
echo "\r\r" >> CONTRIBUTING.rst
cat docs/contributor_tips.rst >> CONTRIBUTING.rst
echo "\r\r" >> CONTRIBUTING.rst
cat docs/core_committer_guide.rst >> CONTRIBUTING.rst
echo "\r\rAutogenerated from the docs via \`make contributing\`" >> CONTRIBUTING.rst
echo "WARNING: Don't forget to replace any :ref: statements with literal names"
WARNING: Don't forget to replace any :ref: statements with literal names
All code changes, regardless of who does them, need to be reviewed and merged by someone else. This rule applies to all the core committers.
Exceptions:
Contributors may be given core commit privileges. Preference will be given to those with: