Skip to content

contribute.rst

Latest commit

 

History

History
81 lines (62 loc) · 3.5 KB

contribute.rst

File metadata and controls

81 lines (62 loc) · 3.5 KB

Development and Contributing

The development of python-for-android is managed by the Kivy team via Github.

Issues and pull requests are welcome via the integrated issue tracker.

Read on for more information about how we manage development and releases, but don't worry about the details! Pull requests are welcome and we'll deal with the rest.

Development model

python-for-android is developed using the following model:

  • The master branch always represents the latest stable release.
  • The develop branch is the most up to date with new contributions.
  • Releases happen periodically, and consist of merging the current develop branch into master.

For reference, this is based on a Git flow model, although we don't follow this religiously.

Versioning

python-for-android releases currently use calendar versioning. Release numbers are of the form YYYY.MM.DD. We aim to create a new release every four weeks, but more frequent releases are also possible.

We use calendar versioning because in practice, changes in python-for-android are often driven by updates or adjustments in the Android build tools. It's usually best for users to be working from the latest release. We try to maintain backwards compatibility even while internals are changing.

Creating a new release

New releases follow these steps:

  • Create a new branch release-YYYY.MM.DD based on the develop branch. - git checkout -b release-YYYY.MM.DD develop
  • Create a Github pull request to merge release-YYYY.MM.DD into master.
  • Complete all steps in the release checklist, and document this in the pull request (copy the checklist into the PR text)

At this point, wait for reviewer approval and conclude any discussion that arises. To complete the release:

  • Merge the release branch to the master branch.
  • Also merge the release branch to the develop branch.
  • Tag the release commit in master, with tag vYYYY.MM.DD. Include a short summary of the changes.
  • Create the release distributions: python3 setup.py sdist bdist_wheel
  • Upload the release to pypi: python3 -m twine upload.
  • Add to the Github release page (see e.g. this example): - The python-for-android README summary - A short list of major changes in this release, if any - A changelog summarising merge commits since the last release - The release sdist and wheel(s)

Release checklist