Contributing to Wagtail¶

Issues¶

The easiest way to contribute to Wagtail is to tell us how to improve it! First, check to see if your bug or feature request has already been submitted at github.com/wagtail/wagtail/issues. If it has, and you have some supporting information which may help us deal with it, comment on the existing issue. If not, please create a new one, providing as much relevant context as possible. For example, if you’re experiencing problems with installation, detail your environment and the steps you’ve already taken. If something isn’t displaying correctly, tell us what browser you’re using, and include a screenshot if possible.

If your bug report is a security issue, do not report it with an issue. Please read our guide to reporting security issues.

Pull requests¶

If you are just getting started with development and have never contributed to an open-source project, we recommend you read the Your first contribution guide. If you’re a confident Python or Django developer, fork it and read the developing docs to get stuck in!

We welcome all contributions, whether they solve problems which are specific to you or they address existing issues. If you’re stuck for ideas, pick something from the issue list, or email us directly on hello@wagtail.org if you’d like us to suggest something!

For large-scale changes, we’d generally recommend breaking them down into smaller pull requests that achieve a single well-defined task and can be reviewed individually. If this isn’t possible, we recommend opening a pull request on the Wagtail RFCs repository, so that there’s a chance for the community to discuss the change before it gets implemented.

Translations¶

Wagtail has internationalisation support so if you are fluent in a non-English language you can contribute by localising the interface.

Translation work should be submitted through Transifex, for information on how to get started see Translations.

Other contributions¶

We welcome contributions to all aspects of Wagtail. If you would like to improve the design of the user interface, or extend the documentation, please submit a pull request as above. Here are some other ways to contribute if you are getting started or have been using Wagtail for a long time but are unable to contribute code.

• Contribute to one of the other core Wagtail projects in GitHub.

• Contribute to one of the community maintained packages on Wagtail Nest.

• Contribute user facing documentation (including translations) on the Wagtail guide.

Developing packages for Wagtail¶

If you are developing packages for Wagtail, you can add the following PyPI classifiers:

• Framework :: Wagtail

• Framework :: Wagtail :: 1

• Framework :: Wagtail :: 2

• Framework :: Wagtail :: 3

• Framework :: Wagtail :: 4

• Framework :: Wagtail :: 5

You can also find a curated list of awesome packages, articles, and other cool resources from the Wagtail community at Awesome Wagtail.

More information¶