Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

30 lines (25 loc) · 1.77 KB
Raw

Contributing

Sgdrf is licensed under the MIT License. New issues and pull requests are welcome. Feel free to direct a question to the authors by creating an issue with the question tag. Contributors are asked to abide by both the GitHub community guidelines and the Contributor Code of Conduct, version 2.0.

Commits

Commits must begin with a valid commit identifier. The full commit string should be in the following format: (build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)(\(\S+\))?!?:(\s.*)

Pull requests

Please update CHANGELOG.md and add your name to the contributors in pyproject.toml so that you’re credited. Run poetry lock and tyrannosaurus sync to sync metadata. Feel free to make a draft pull request and solicit feedback from the authors.

Publishing a new version

  1. Bump the version in tool.poetry.version in pyproject.toml, following Semantic Versioning.
  2. Run tyrannosaurus sync so that the Poetry lock file is up-to-date and metadata are synced to pyproject.toml.
  3. Create a new release with both the name and tag set to something like v1.4.13 (keep the v).
  4. An hour later, check that the publish on release creation workflow passes and that the PyPi and GitHub Package versions are updated as shown in the shields on the readme.