Skip to content

Latest commit

 

History

History
19 lines (13 loc) · 897 Bytes

CONTRIBUTING.md

File metadata and controls

19 lines (13 loc) · 897 Bytes
Raw

Contribution guidelines

Contributions are welcome as long as they follow core rule of the project:

The API of pyppeteer should match the API of puppeteer as closely as possible without sacrificing python too much. ie keep public API keywords such as method names, arguments, class names etc. as they are in puppeteer version.

Other than that the contributions should remain as pythonic as possible and pass linting and code tests.

Changes worthy of a changelog entry should get one - simply follow the existing format in CHANGELOG.md

Maintainers - creating a release

  • Make sure all relevant changes have been recorded in the changelog
  • Ensure that code is properly tested
  • Bump the version in pyproject.toml, then tag the release in git
    • ex: git tag -a 2.0.0rc1 -m "pypi release"
  • Run poetry build
  • Run poetry publish