Skip to content

Contributing

Contributions are always welcome! Please submit a pull request with your improvements or open an issue to discuss.

Development

  1. Clone the repository: 

    git clone https://github.com/3xp0rt/naminter.git
cd naminter

  2. Install in editable mode with dev dependencies:

    uv sync --extra dev

    Alternatively, using uv pip:

    uv pip install -e ".[dev]"

  3. Run linting: 

    uv run ruff format
uv run ruff check

Documentation

This project uses MkDocs with Material for MkDocs for documentation.

Serving docs locally

To preview documentation changes locally:

mkdocs serve

This starts a local server at http://127.0.0.1:8000/ with live reload.

Building docs

To build the static documentation site:

mkdocs build

The built site will be in the site/ directory.

Documentation structure

  • docs/ - Documentation source files (Markdown)
  • mkdocs.yml - MkDocs configuration
  • API documentation is auto-generated from docstrings using mkdocstrings

Code Style

This project uses:

  • Ruff for linting and formatting
  • Google-style docstrings
  • Type hints for all function signatures

Submitting Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes following the code style guidelines
  4. Run linting and ensure all checks pass
  5. Commit your changes using Conventional Commits format
  6. Push to your fork (git push origin feature/amazing-feature)
  7. Open a pull request with a detailed description of your changes

Commit Message Guidelines

This project follows the Conventional Commits specification. Each commit message should be structured as follows:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit Types

Type Description
feat A new feature
fix A bug fix
docs Documentation only changes
style Changes that do not affect the meaning of the code (formatting, etc.)
refactor A code change that neither fixes a bug nor adds a feature
perf A code change that improves performance
test Adding missing tests or correcting existing tests
build Changes that affect the build system or external dependencies
ci Changes to CI configuration files and scripts
chore Other changes that don't modify src or test files

Examples

feat: add validation support
fix: resolve timeout issue in network requests
docs: update installation instructions
refactor(core): simplify validation logic
chore(release): bump version to 1.0.7

Pull Request Guidelines

  • Provide a clear description of what the PR does
  • Reference any related issues
  • Ensure code follows the project's style guidelines
  • Update documentation if needed