Skip to content

Latest commit

 

History

History
38 lines (24 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

38 lines (24 loc) · 1.31 KB

Contribution guidelines

Thanks that you want to contribute to ViUR!

Issues

In case you encounter a bug, or you miss a feature, please file an issue.

Pull Requests

If you created a solution for a problem or added a feature, please make a pull request. This can also be done as a draft, in case you want to discuss a change or aren't finished.

Releases

viur-core uses the semantic versioning scheme. Any major/minor/bugfix release is being published to PyPI. A pre-release is marked as "rc" for release-candidate and is also published.

In case you have appropriate permissions, a release can be done this way:

  • Bump version number in core/version.py
  • Update CHANGELOG.md and also check version number there
  • Build and publish the package
    • Run pipenv install once
    • Ensure any old files are deleted by running pipenv run clean
    • Build the wheel using pipenv run build
    • Release the package
      • PyPI: pipenv run release
      • TestPyPI: pipenv run develop

Branches

viur-core has two branches:

  • main is the current stable version as released on PyPI.
  • develop is the next minor version and may be released as release candidates to PyPI.

Maintenance

Maintainer of this project is @phorward.