Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
32 lines (23 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

32 lines (23 loc) · 1.03 KB
Raw

Contributing to jMetalPy

Thanks for your interest in contributing! This file covers the practical setup; the actual standards live in a few dedicated documents so they don't drift out of sync with this one:

  • AGENTS.md — project layout, scope, and conventions (written for AI assistants and human contributors alike).
  • CODING_GUIDELINES.md — style, typing, docstrings, and test conventions.
  • GIT_GUIDELINES.md — commit message format (Conventional Commits) and atomic-commit practices.

Getting set up

$ git clone https://github.com/jMetal/jMetalPy.git
$ cd jMetalPy
$ pip install -e ".[dev]"

Before opening a pull request

$ make lint    # ruff check
$ make test    # pytest

Both must pass. Follow GIT_GUIDELINES.md for commit messages — one logical change per commit, Conventional Commits format, English only.

Reporting bugs and requesting features

Use GitHub Issues.