Contributing to MkDocs Note¶

First off, thank you for considering contributing to MkDocs Note! It's people like you that make the open-source community such a great place.

How Can I Contribute?¶

There are many ways to contribute, from writing documentation and tutorials to reporting bugs and submitting code changes.

For developers, you'd better to read Architecture Overview first in order to understand the project framework and design philosophy.

For more details of plugin's api, you can refer to API References.

Reporting Bugs¶

If you find a bug, please open an issue and provide the following information:

A clear and descriptive title.
A detailed description of the problem, including steps to reproduce it.
Your MkDocs configuration (mkdocs.yml).
Any relevant error messages or logs.

Suggesting Enhancements¶

If you have an idea for a new feature or an improvement to an existing one, please open an issue to discuss it. This allows us to coordinate our efforts and avoid duplicating work.

Development Setup¶

To get started with local development, follow these steps:

Fork and Clone the Repository

git clone https://github.com/YOUR_USERNAME/mkdocs-note.git
cd mkdocs-note

Set Up the Environment

It's strongly recommended to use a virtual environment, and recommended to use uv to manage project configuration and virtual environment.
Install Dependencies

Install the project in editable mode along with the development dependencies.
```
uv sync --extra dev
```
Run Tests

To make sure everything is set up correctly, use pytest run the test suite:
```
uv run pytest
```

Pull Request Process¶

Ensure any new code is covered by tests.
Update the documentation if you've added or changed any features.
Make sure the test suite passes (pytest).
Submit your pull request!

Thank you for your contribution!