Note
These guidelines are based on the best practice established by the Jazzband project,a community of contributors that shares the responsibility of maintainingPython-based projects.
The django CMS ecosystem consists of many custom projects. Often these projects aremaintained by the author themselves. However, sometimes it can make sense to put aproject in the care of the django CMS project. Either because it is of interest to theentire community, or because the author can no longer devote time to maintain theproject themselves.
Whether an existing project is transferred to the django CMS Github organization, or anew project is set up within the django CMS Github organization, it is important thatcertain standards are followed.
Projects must meet the criteria of viability, documentation, testing, code of conductsand contributing guidelines. But before that, they must be approved by the TechCommittee.
New projects or project transfers under the django CMS patronage must first be approvedby theTech Committee.For that you should join the #tech-committee channel onDiscord and simply submit your proposal. Then, the TCdecides whether or not your project is in line with the product roadmap and overallvision for django CMS.
Projects to be maintained by the django CMS project must have a certain maturity (Noproof of concepts, one-off toys or code snippet hosts) and provide useful functionality.They should also be transferred to django CMS with the agreement of the previousmaintainer and in consultation with the Tech Committee (seeTech Committee).
Project documentation is one of the most important aspects of a project. For thisreason, it is of utmost importance that the project includes prose documentation for endusers and contributors. It is also strongly recommended to prepare inline codedocumentation, as this is considered an indicator of high quality code. Please documentas much as possible, but also as clearly and concisely as possible. To quoteJazzband “Write like you’re addressing yourself in a fewyears.” More information about how to contribute software documentation can be foundhere.
Your contributions and fixes are more than welcome as are your tests. We do not want tocompromise our codebase. Therefore, you are going to have to include tests if you wantto contribute. For more information about running and writing tests pleasesee here.
Projects are required to adopt and follow the django CMScode of conduct. Please seethe Contributor Code of Conduct for more information about what that entails and how toreport conduct violations.
Projects have to add a CONTRIBUTING.md (Markdown ) or CONTRIBUTING.rst (reStructuredText) file to their repository so it’s automatically displayed when new issues and pullrequests are created.
The respective file needs to contain this text:
First of all, thank you for wanting to contribute to the django CMS. We always welcomecontributions, like many other open-source projects. We are very thankful to the manypresent, past and future contributors, to ourcommunityheroesand to the [members of thedjango CMS Association.This is adjango CMS project. By contributing you agreeto abide by theContributor Code of Conduct and followtheguidelines. Ofcourse extending the contributing document with your project’s contributing guide ishighly encouraged, too. See GitHub’s documentation on contributing guidelines for moreinformation.
To initiate the transfer to django CMS, you should use Github’sTransfer Featureto transfer the repository to the django CMS organization.