Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
193 lines (126 loc) · 5.54 KB

CONTRIBUTING.md

File metadata and controls

193 lines (126 loc) · 5.54 KB
Raw

Contributing to docx-editor

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/pablospe/docx-editor/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 a fix for 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

docx-editor 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.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/pablospe/docx-editor/issues.

If you are proposing a new 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 docx-editor for local development. Please note this documentation assumes you already have uv and Git installed and ready to go.

  1. Fork the docx-editor repo on GitHub.

  2. Clone your fork locally:

cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/docx-editor.git
  1. Now we need to install the environment. Navigate into the directory
cd docx-editor

Then, install and activate the environment with:

uv sync
  1. Install pre-commit to run linters/formatters at commit time:
uv run pre-commit install
  1. Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.

  1. Don't forget to add test cases for your added functionality to the tests directory.

  2. When you're done making changes, check that your changes pass the formatting tests.

make check

Now, validate that all unit tests are passing:

make test
  1. Before raising a pull request you should also run tox. This will run the tests across different versions of Python:
tox

This requires you to have multiple versions of python installed. This step is also triggered in the CI/CD pipeline, so you could also choose to skip this step locally.

  1. Commit your changes and push your branch to GitHub:
git add <changed-files>
git commit -m "Your detailed description of your changes."
git push origin name-of-your-bugfix-or-feature
  1. 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.

Releasing a New Version

This project uses GitHub Releases to trigger automated publishing to PyPI and docs deployment.

Steps

  1. Update the version in both files on main:

    • pyproject.toml → version = "X.Y.Z"
    • .claude-plugin/plugin.json → "version": "X.Y.Z"

    The release workflow also re-stamps pyproject.toml from the release tag before building. The manual bump is still required so main, uv.lock, and plugin metadata are consistent before the release starts.

  2. Refresh uv.lock so its pinned project version matches:

    uv lock

    Skipping this makes make check and release validation fail with The lockfile at 'uv.lock' needs to be updated, but '--locked' was provided.

  3. Run the local checks:

    make check
make test

  4. Commit and push the version bump:

    git add pyproject.toml .claude-plugin/plugin.json uv.lock
git commit -m "bump version to X.Y.Z"
git push origin main

  5. Create a GitHub Release:

    • Go to Releases
    • Create a new tag matching the version: X.Y.Z (e.g., 0.3.0). Do not use a v prefix.
    • Set the target branch to main
    • Add release notes (use "Generate release notes" for a changelog)
    • Click Publish release

  6. Automated CI (.github/workflows/on-release-main.yml) will:

    • Validate that the release tag, pyproject.toml, uv.lock, and .claude-plugin/plugin.json versions match
    • Update pyproject.toml version from the release tag before packaging
    • Build the package with uv build
    • Publish to PyPI via trusted publishing
    • Deploy documentation to GitHub Pages with mkdocs gh-deploy

  7. Verify the release:

    • Check that the release workflow completed successfully in GitHub Actions
    • Confirm the new version appears on PyPI
    • Confirm the documentation was deployed to GitHub Pages

Notes

  • The release tag must match the version format exactly (e.g., 0.3.0, no v prefix)
  • PyPI publishing uses trusted publishing (no API tokens needed)
  • If you need to build and publish manually, you can use make build-and-publish