Skip to content

Add CONTRIBUTING.md with setup and contribution guidelines#451

Closed
sidhantpande wants to merge 1 commit intomllam:mainfrom
sidhantpande:docs/add-contributing-guide
Closed

Add CONTRIBUTING.md with setup and contribution guidelines#451
sidhantpande wants to merge 1 commit intomllam:mainfrom
sidhantpande:docs/add-contributing-guide

Conversation

@sidhantpande
Copy link
Copy Markdown

Describe your changes

Add a CONTRIBUTING.md file at the repository root covering:

  • Development environment setup using uv
  • Running tests with pytest
  • Running pre-commit hooks (black, isort, flake8, mypy, codespell)
  • Branch naming conventions (feat/, fix/, docs/, test/, maintenance/)
  • Commit message style guide (imperative verb form)
  • PR checklist for contributors
  • Where to get help (GitHub Issues, MLLAM Slack)

Issue Link

closes #450

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the README to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form
  • I have requested a reviewer and an assignee

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change:
    • maintenance: add CONTRIBUTING.md with setup and contribution guidelines

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • (if the PR is not just maintenance/bugfix) the PR is assigned to the next milestone. If it is not, propose it for a future milestone.
  • author has added an entry to the changelog (and designated the change as added, changed, fixed or maintenance)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@sadamov
Copy link
Copy Markdown
Collaborator

sadamov commented Mar 21, 2026

closing this as duplicate of #406 #407

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md with setup and contribution guidelines

2 participants