Skip to content

Latest commit

 

History

History
110 lines (84 loc) · 5.18 KB

CONTRIBUTING.md

File metadata and controls

110 lines (84 loc) · 5.18 KB
Raw

Contributing

As an open source project, Mesa welcomes contributions of many forms, and from beginners to experts. If you are curious or just want to see what is happening, we post our development session agendas and development session notes on Mesa discussions. We also have a threaded discussion forum on Matrix for casual conversation.

In no particular order, examples include:

  • Code patches
  • Bug reports and patch reviews
  • New features
  • Documentation improvements
  • Tutorials

No contribution is too small. Although, contributions can be too big, so let's discuss via Matrix OR via an issue.

To submit a contribution

  • Create a ticket for the item that you are working on.
  • Fork the Mesa repository.
  • Clone your repository from Github to your machine.
  • Create a new branch in your fork: git checkout -b BRANCH_NAME
  • Run git config pull.rebase true. This prevents messy merge commits when updating your branch on top of Mesa main branch.
  • Install an editable version with developer requirements locally: pip install -e ".[dev]"
  • Edit the code. Save.
  • Git add the new files and files with changes: git add FILE_NAME
  • Git commit your changes with a meaningful message: git commit -m "Fix issue X"
  • If implementing a new feature, include some documentation in docs folder.
  • Make sure that your submission works with a few of the examples in the examples repository. If adding a new feature to mesa, please illustrate usage by implementing it in an example.
  • Make sure that your submission passes the GH Actions build. See "Testing and Standards below" to be able to run these locally.
  • Make sure that your code is formatted according to [the black] standard (you can do it via pre-commit).
  • Push your changes to your fork on Github: git push origin NAME_OF_BRANCH.
  • Create a pull request.
  • Describe the change w/ ticket number(s) that the code fixes.
  • Format your commit message as per Tim Pope's guideline.

Testing and Code Standards

:target: https://codecov.io/gh/projectmesa/mesa

:target: https://github.com/psf/black

As part of our contribution process, we practice continuous integration and use GH Actions to help enforce best practices.

If you're changing previous Mesa features, please make sure of the following:

  • Your changes pass the current tests.
  • Your changes pass our style standards.
  • Your changes don't break the models or your changes include updated models.
  • Additional features or rewrites of current features are accompanied by tests.
  • New features are demonstrated in a model, so folks can understand more easily.

To ensure that your submission will not break the build, you will need to install Ruff and pytest.

pip install ruff pytest pytest-cov

We test by implementing simple models and through traditional unit tests in the tests/ folder. The following only covers unit tests coverage. Ensure that your test coverage has not gone down. If it has and you need help, we will offer advice on how to structure tests for the contribution.

py.test --cov=mesa tests/

With respect to code standards, we follow PEP8 and the Google Style Guide. We use [ruff format] (a more performant alternative to black) as an automated code formatter. You can automatically format your code using pre-commit, which will prevent git commit of unstyled code and will automatically apply black style so you can immediately re-run git commit. To set up pre-commit run the following commands:

pip install pre-commit
pre-commit install

You should no longer have to worry about code formatting. If still in doubt you may run the following command. If the command generates errors, fix all errors that are returned.

ruff .

Licensing

The license of this project is located in LICENSE. By submitting a contribution to this project, you are agreeing that your contribution will be released under the terms of this license.

Special Thanks

A special thanks to the following projects who offered inspiration for this contributing file.