Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
160 lines (109 loc) · 4.89 KB

CONTRIBUTING.md

File metadata and controls

160 lines (109 loc) · 4.89 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/feldroy/AirPostgres/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.

Write Documentation

AirPostgres could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

To preview the docs locally:

just docs-serve

This starts a local server at http://localhost:8000 with live reload. Edit files in docs/ or add docstrings to your code (the API reference page is auto-generated). Run just docs-build to verify a production build.

Docs deploy automatically on push to main after GitHub Pages is enabled. If the generator did not enable it, review the visibility implications first: Pages sites can be public even when their repositories are private, and the feature may require a paid GitHub plan for private repositories. Then go to Settings > Pages, set the source to GitHub Actions, and enable the deployment workflow:

gh variable set DOCS_DEPLOYMENT_ENABLED \
    --repo feldroy/AirPostgres \
    --body true

Until then, deployment stays paused and local preview and builds still work.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/feldroy/AirPostgres/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here's how to set up AirPostgres for local development.

  1. Fork the AirPostgres repo on GitHub.

  2. Clone your fork locally:

    git clone git@github.com:your_name_here/AirPostgres.git

  3. Install your local copy with uv:

    cd AirPostgres/
uv sync

  4. Create a branch for local development:

    git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, verify formatting, linting, types, and tests without modifying files:

    just check

    Use just fix to apply Ruff's automatic fixes, or just fix-and-check to apply them before verification.

    Or run the tests alone:

    just test

  6. Commit your changes and push your branch to GitHub:

    git add .
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.md.
  3. The pull request should work for Python 3.13 and 3.14. Tests run in GitHub Actions on every pull request to the main branch, make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

uv run pytest tests/

Releasing a New Version

  1. Bump the version: 
    uv version <version>        # or: uv version --bump minor
  2. Commit: 
    git add pyproject.toml uv.lock
git commit -m "Bump version to <version>"
  3. Release: 
    just release
    This finalizes CHANGELOG/unreleased.md as CHANGELOG/<version>.md, creates a fresh unreleased file, commits and pushes that notes commit, then creates an annotated v* tag and GitHub Release. The tag push triggers .github/workflows/publish.yml, which builds the package, generates SLSA provenance attestations, and publishes to PyPI via trusted publishing.

Record release-worthy changes in CHANGELOG/unreleased.md as they merge. Projects generated before this changelog lifecycle was introduced remain compatible when they already have a versioned changelog file.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.