123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100 |
- Contributing
- ============
- Developing and testing coderedcms
- To create a test project locally:
- which is relevant when running makemigrations in test project to actually generate the migration
- files in the coderedcms pip package. The ``[dev]`` installs extras such as sphinx for generating docs.
- your project name to ensure it is ignored by git.
- test project to generate the relevant migration files for the pip package. ALWAYS follow steps
- 4 and 5 in :doc:`/getting_started/install` with a fresh database before making migrations.
- ``makemigrations website`` in the test project to generate the relevant migration files locally.
- Apply and test the migrations. When satisfied, copy the new migration files to the
- ``project_template/website/migrations/`` directory.
- When making changes that are potentially destructive or backwards incompatible, increment the minor
- version number until coderedcms reaches a stable 1.0 release. Each production project that uses
- coderedcms should specify the appropriate version in its requirements.txt to prevent breakage.
- .. note:
- When testing existing projects with coderedcms installed from the master or development branches,
- be sure to use a disposable database, as it is likely that the migrations in master will
- not be the same migrations that get released.
- Contributor guidelines
- We are happy to accept pull requests from the community if it aligns with our vision for coderedcms.
- When creating a pull request, please make sure you include the following:
- * A description in the pull request of what this change does and how it works.
- * Reference to an issue if the change is related to one of the issues on our GitHub page.
- * Documentation updates in the ``docs/`` directory describing your change.
- Following submission of your pull request, a CodeRed member will review and test your change.
- **All changes, even by CodeRed members, must go through a pull request process to ensure quality.**
- Building pip packages
- To build a publicly consumable pip package, run::
- python setup.py sdist bdist_wheel
- Building documentation
- For every code or feature change, be sure to update the docs in the repository. To build and publish
- the documentation run::
- cd docs/
- make clean
- make html
- Output will be in ``docs/_build/html/`` directory.
- Publishing a new release
- First checkout the code/branch for release.
- Next build a pip package::
- python setup.py sdist bdist_wheel
- Then upload the pip package to pypi::
- twine upload dist
|