Contributing to the App¶
The project is packaged with a light development environment based on docker-compose
to help with the local development of the project and to run tests.
The project is following Network to Code software development guidelines and is leveraging the following:
- Python linting and formatting:
black
,pylint
,bandit
,flake8
, andpydocstyle
. - YAML linting is done with
yamllint
. - Django unit test to ensure the plugin is working properly.
Documentation is built using mkdocs. The Docker based development environment automatically starts a container hosting a live version of the documentation website on http://localhost:8080 that auto-refreshes when you make any changes to your local files.
Branching Policy¶
The branching policy includes the following tenets:
- The
main
branch is locked and can only have a PR merged to it; however, we should only merge to main fromdevelop
. - The
develop
branch is the default branch. - PRs intended to add new features should be branched from and merged to the next branch.
- PRs intended to add new features that break backward compatibility should be discussed before a PR is created.
- PRs intended to address bug fixes and security patches should be branched from and merged to the develop branch.
Release Policy¶
Show Tech has currently no intended scheduled release schedule, and will release new features in minor versions.
When a new release of any kind (e.g. from develop
to main
, or a release of a stable-<major>.<minor>
) is created the following should happen.
- A release PR is created:
- Add and/or update to the changelog in
docs/admin/release_notes/version_<major>.<minor>.md
file to reflect the changes. - Update the mkdocs.yml file to include updates when adding a new release_notes version file.
- Change the version from
<major>.<minor>.<patch>-beta
to<major>.<minor>.<patch>
in pyproject.toml. - Set the PR to the proper branch, e.g. either
main
orstable-<major>.<minor>
.
- Add and/or update to the changelog in
- Ensure the tests for the PR pass.
- Merge the PR.
- Create a new tag:
- The tag should be in the form of
v<major>.<minor>.<patch>
. - The title should be in the form of
v<major>.<minor>.<patch>
. - The description should be the changes that were added to the
version_<major>.<minor>.md
document.
- The tag should be in the form of
- If merged into
main
, then push frommain
todevelop
, in order to retain the merge commit created when the PR was merged. - If the is a new
<major>.<minor>
, create astable-<major>.<minor>
for the previous version, so that security updates to old versions may be applied more easily. - A post release PR is created:
- Change the version from
<major>.<minor>.<patch>
to<major>.<minor>.<patch + 1>-beta
in pyproject.toml. - Set the PR to the proper branch, e.g. either
develop
orstable-<major>.<minor>
. - Once tests pass, merge.
- Change the version from