Contributing

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/sunil-fm/FusePyStarter/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 that are tagged with bug.

Implement Features

Look through the GitHub issues for features that are tagged with enhancement.

Write Documentation

FusePyStarter 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/sunil-fm/FusePyStarter/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.

Get Started!

Ready to contribute? Here’s how to set up FusePyStarter for local development. Please note this documentation assumes you already have uv and git installed and ready to go.

Clone the FusePyStarter repo locally:

$ git clone git@github.com:sunil-fm/FusePyStarter.git
$ cd FusePyStarter

Create and activate a virtual environment (optional but recommended):

$ uv venv .venv
$ source venv/bin/activate  # On Windows use `venv\Scripts\activate`

Install the package and development dependencies using UV:
```
$ uv sync --dev
```
Create a branch for local development:
```
$ git checkout -b name-of-your-bugfix-or-feature
```
Now you can make your changes locally.
Before raising a pull request you should run the tests and checks:
```
$ pytest
$ pre-commit run --all-files
```
If your contribution is a bug fix or new feature, you may want to add a test to the existing test suite. See the section Add a New Test below for details.

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

Submit a pull request through the GitHub website.

Pull Request Guidelines

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

The pull request should include tests.
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.rst.
The pull request should work for all supported Python versions. Check https://github.com/sunil-fm/FusePyStarter/actions and make sure that the tests pass for all supported Python versions.

Add a New Test

When fixing a bug or adding features, it’s good practice to add a test to demonstrate your fix or new feature behaves as expected. These tests should focus on one tiny bit of functionality and prove changes are correct.

To write and run your new test, follow these steps:

Add the new test to tests/<module>/test_<feature>.py. Focus your test on the specific bug or a small part of the new feature.
If you have already made changes to the code, stash your changes and confirm all your changes were stashed:
```
$ git stash
$ git stash list
```
Run your test and confirm that your test fails. If your test does not fail, rewrite the test until it fails on the original code:
```
$ pytest
```
(Optional) Run the tests with different Python versions if needed.
Proceed work on your bug fix or the new feature or restore your changes. To restore your stashed changes and confirm their restoration:
```
$ git stash pop
$ git stash list
```
Rerun your test and confirm that your test passes. If it passes, congratulations!

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in CHANGELOG.rst). Then follow these steps:

First, ensure the __version__ in fusepystarter/__init__.py is updated to the new version.
Create an annotated git tag for the release (the tag should match the version in __init__.py):
```
$ git tag -a vX.Y.Z -m "Version X.Y.Z"
```
Replace X.Y.Z with the actual version number (e.g., v1.0.0).
Push the tag to GitHub:
```
$ git push origin vX.Y.Z
```
GitHub Actions will automatically: - Run the test suite - Build the package - Deploy to PyPI if all tests pass

For major releases (X.0.0) or minor releases (X.Y.0), create a new release in GitHub’s web interface with release notes.

Note

Make sure your PyPI credentials are properly set up in GitHub Secrets for the deployment to work.