Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 2.59 KB

CONTRIBUTING.rst

File metadata and controls

62 lines (44 loc) · 2.59 KB

Contribute to pytest-postgresql

Thank you for taking time to contribute to pytest-postgresql!

The following is a set of guidelines for contributing to pytest-postgresql. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.

Bug Reports

  1. Use a clear and descriptive title for the issue - it'll be much easier to identify the problem.
  2. Describe the steps to reproduce the problems in as many details as possible.
  3. If possible, provide a code snippet to reproduce the issue.

Feature requests/proposals

  1. Use a clear and descriptive title for the proposal
  2. Provide as detailed description as possible
    • Use case is great to have
  3. There'll be a bit of discussion for the feature. Don't worry, if it is to be accepted, we'd like to support it, so we need to understand it thoroughly.

Development

  1. Fork the repository
  2. Clone the repository
  3. Create a virtual environment with pipenv install --dev

Pull requests

  1. Start with a bug report or feature request
  2. Use a clear and descriptive title
  3. Provide a description - which issue does it refers to, and what part of the issue is being solved
  4. Be ready for code review :)

Commits

  1. Make sure commits are atomic, and each atomic change is being followed by test.
  2. If the commit solves part of the issue reported, include refs #[Issue number] in a commit message.
  3. If the commit solves whole issue reported, please refer to Closing issues via commit messages for ways to close issues when commits will be merged.

Coding style

  1. Coding style is being handled by black and doublechecked by ruff.
    • We provide a pre-commit configuration for invoking these on commit.

Testing

  1. Tests are written using pytest
  2. PR tests run on Github Actions.
  3. Run a PostgreSQL server [1], and create a default super user createuser --superuser postgres
  4. Set envvar named POSTGRES with used version number
  5. Run tests with pipenv run pytest
  6. If you encounter any test failures due to locale issues, make sure that both en_US.UTF-8 and de_DE.UTF-8 are enabled in /etc/locale.gen and then run sudo locale-gen.
[1]Installing and configuring a PostgreSQL server is out of scope of this document. Please refer to PostgreSQL documentation for more information.