# Contributing to up-mcp-email

Contributions are welcome, and they are greatly appreciated!

## About This Fork

This is a fork of [mcp-email-server](https://github.com/ai-zerolab/mcp-email-server) by ai-zerolab, maintained by [ultraBASE.net](https://ultrabase.net).

When contributing, consider whether your change:
- **Applies to the upstream** (core IMAP/SMTP functionality) - consider contributing to [ai-zerolab/mcp-email-server](https://github.com/ai-zerolab/mcp-email-server)
- **Is specific to this fork** (ultraBASE enhancements) - contribute here

---

# Types of Contributions

## Report Bugs

Report bugs at https://github.com/ultraBASE/up-mcp-email/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

up-mcp-email 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/ultraBASE/up-mcp-email/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 `up-mcp-email` for local development.
Please note this documentation assumes you already have `uv` and `Git` installed and ready to go.

1. Fork the `up-mcp-email` repo on GitHub.

2. Clone your fork locally:

```bash
cd <directory_in_which_repo_should_be_created>
git clone git@github.com:YOUR_NAME/up-mcp-email.git
```

3. Now we need to install the environment. Navigate into the directory

```bash
cd up-mcp-email
```

Then, install and activate the environment with:

```bash
uv sync
```

4. Install pre-commit to run linters/formatters at commit time:

```bash
uv run pre-commit install
```

5. Create a branch for local development:

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

Now you can make your changes locally.

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

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

```bash
make check
```

Now, validate that all unit tests are passing:

```bash
make test
```

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

```bash
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.

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

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

10. 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`.
