Contributing to development

We welcome contributions to the code base and development of new features for the MESSAGEix framework. This page contains guidelines for making such contributions. Each section requires some of the listed prerequisite knowledge and skills; use the links there to external resources about git, Github, Python, etc. to ensure you are able to understand and complete the steps.

On this page:

On separate pages:

File issues for bugs and enhancements

We use Github issues for several purposes:

  • Ask and answer questions about intended behaviour or issues running the framework or related models.

  • Report bugs, i.e. unintended or undocumented behaviour.

  • Request changes to exiting behaviour.

  • Request specific enhancements and new features, both urgent and long-term/low-priority.

  • Discuss and design of other improvements.

Please search through open and closed issues for both the message_ix and ixmp repositories. Review any related issues. Then, if your issue is not found, open a new one.

Contribute code via Github PRs

1. Choose a repository

Decide which part of the MESSAGEix software stack is the appropriate location for your code:

ixmp

Contributions not specific to MESSAGEix model framework, e.g. that could be used for other, non-MESSAGE models.

ixmp_source

Java / JDBC backend for ixmp.

message_ix

Contributions not specific to any particular MESSAGEix model instance. Additions to message_ix should be usable in any MESSAGE-scheme model.

message_data or message_doc

Contributions to the MESSAGE-GLOBIOM family of models, including the global model; and its documentation, respectively.

2. Fork, branch, and open a pull request

Register a Github account, if you do not already have one. Fork the chosen repository to your own Github account. Create a branch with an appropriate name:

  • all-lower-case-with-hyphens —underscores (_) are slower to type; don’t use them.

  • issue/1234 if you are addressing a specific issue.

  • feature/do-something if you are adding a new feature.

  • Don’t use the main branch in your fork for a PR. This makes it hard for others to check out and play with your code.

Open a PR (e.g. on message_ix) to merge your code into the main branch. The message_ix and ixmp repositories each have a template for the text of the PR that is designed to help you write a clear description. It includes:

  • A title and one-sentence summary of the change. This is like the abstract of a publication: it should help a developer/reviewer/user quickly learn what the PR is about.

  • Confirm that unit or integration tests have been added or revised to cover the changed code, and that the tests pass (see below).

  • Confirm that documentation of the API and its usage is added or revised as necessary.

  • Add a line to RELEASE_NOTES.rst describing the changes (use the same title or one-sentence summary as above) and linking to the PR.

Optionally:

  • Assign yourself and anyone else who will actually commit changes to the PR branch, or be actively involved in discussing/designing the code.

  • Include a longer description of the design, or any changes whose purpose is not clear by inspecting code.

  • Put “WIP:” or the construction sign Unicode character (🚧) at the start of the PR title to indicate “work in progress” while you continue to add commits; or use GitHub’s ‘draft’ pull requests feature. This is good development practice: it ensures the automatic checks pass as you add to the code on your branch.

3. Ensure checks pass

MESSAGEix has several kinds of automatic, or continuous integration, checks:

  • The CLA Assistant ensures you have signed the Contributor License Agreement (follow link for text). All contributors are required to sign the CLA before any pull request can be reviewed. This ensures that all future users can benefit from your contribution, and that your contributions do not infringe on anyone else’s rights.

  • GitHub Actions is used to run several workflows. These are defined by YAML files in .github/workflows/:

    pytest

    This workflow runs all Python and R tests; on Linux, macOS, and Windows; and for multiple versions of Python.

    lint

    This workflow checks for code style and other details:

    • “Lint with flake8”: checks that Code style is met.

    • “Test package build”: checks that the Python package for upload to PyPI, can be built cleanly and without errors.

    • “Test documentation build”: checks that the documentation can be built without fatal errors.

    nightly

    These tests run daily at 05:00 UTC. They download a particular package of full-scale, MESSAGEix-GLOBIOM global model scenarios from IIASA servers. Each scenario’s outputs are compared to an expected value listed in message_ix/tests/data/scenarios.yaml. PRs that touch the GAMS code may cause the these objective function values to change; the values must be updated as part of such PRs. See the comments in the file for how to temporarily enable these checks for every commit on a PR branch.

    anaconda, miniconda

    These workflows check that the package can be installed from conda-forge using Anaconda and Miniconda, respectively, on Windows only.

Resolve any non-passing checks—seeking help if needed.

If your PR updates the documentation, the lint check will confirm that it can be built. However, you should also manually build and view the HTML documentation on your machine to confirm that the generated HTML is as expected, and address any warnings generated by Sphinx during the build phase. See doc/README.rst.

4. Review

Using the GitHub sidebar on your PR, request a review from another MESSAGEix contributor. GitHub suggests reviewers; optionally, contact the IIASA ECE Program to ask who should review your code.

  • If you want them to follow along with progress, tag them in the PR description, like “FYI @Alice @Bob”.

  • Only formally request review once the code is ready to review. Doing this sends e-mail and other notifications (e.g. in Slack, the “Pull Reminders” bot sends notices every day). If the code is not yet complete and ready for review, these notifications are noise.

Address any comments raised by the reviewer.

5. Merge

GitHub provides three ways to incorporate a pull request: merge, rebase, and squash. Current practice for the ixmp, message_ix, and message_data repositories is:

  • Use squash and merge…

    • if the commit history for the PR is “messy”, e.g. there are many merge commits from other branches, or the author did not write well-formatted commit messages (see “Code style”, below).

    • if the PR is very old, i.e. it starts at an old commit on main. However, it is better to rebase the PR branch on the HEAD of main and then use a merge commit (below).

  • Use rebase and merge…

    • if the PR is only one or a few commits that are obviously related.

    • if the PR does not involve user-facing changes, i.e. does not need to be linked from the release notes.

  • Use merge pull request (also written “create a merge commit”) in all other cases.

    PR branches should be rebased on the HEAD of main before merging. This is because some git-based tools will display commits from main and the PR branch interleaved if their dates and times are mixed, which makes it harder to read the commit history. Rebasing avoids this problem by ensuring each PR’s commits are displayed together & in sequence.

Code style

  • For both commit messages and pull request (PR) titles, memorize and use the “7 rules of a great Git commit message”.

  • Python code:

    • Follow the PEP 8 naming conventions.

    • Apply the following to all code:

      isort -rc . && black . && mypy . && flake8

      Links to the documentation for these tools:

      • isort: sorts import lines at the top of code files in a consistent way.

      • black: applies consistent code style & formatting. Plugins are available for popular code editors.

      • mypy: checks typing for inconsistencies.

      • flake8: check code style against PEP 8.

      The lint continuous integration workflow runs these on every pull request. PRs that fail the checks must be corrected before they can be merged.

    • Add type hints to new or changed functions, methods, and global variables.

  • GAMS code:

    • Wrap lines at 121 characters, except for inline documentation (see above).

  • R code: follow the style of the existing code base.

  • Jupyter notebooks (.ipynb): see Developing tutorials.

  • Other (file names, CLI, etc.): follow the style of the existing code base, e.g.:

    • Use lower-case file names and extensions.

    • Except for Python source files, prefer hyphens to underscores.

Documentation

  • Write documentation in ReStructuredText formats for:

    1. Python docstrings.

    2. Documentation pages, doc/*.rst.

    3. Inline documentation in message_ix/model/*.gms files.

    For (2) and (3), start each sentence on a new line, and do not hard-wrap sentences. For (1), wrap at the same 88 characters as black enforces for code.

  • Ensure Sphinx does not give warnings about ReST syntax for new or modified documentation.

  • Use sphinx.ext.intersphinx (click for docs) to create cross-links within one project’s documentation, or across projects.

    • Understand the use of the ~ and . characters to resolve references across the project. See Cross-referencing syntax in the Sphinx docs.

    • See example usage in existing code.

    • Check that intersphinx links are correctly resolved, by building the docs and attempting to click new or modified links.

  • Write docstrings in the numpydoc style.

    Use single backticks to refer to function arguments, and asterisks for italics:

    def func(foo: str, bar: str) -> float:
    """Perform some action.

    If `foo` and `bar` have the same value, ``42.1`` is returned. *Nice!*
    """

References:

Manage issues and pull requests

  • Assign an issue or PRs to the person(s) who must take the next action towards completing it. For example:

    • Comment on the issue to provide information/decisions needed to move forward.

    • Implement the requested changes in code.

    This might be different from the person who opened the issue/PR.

  • Use the GitHub auto-linking feature to make clear the connection between related issues and PRs.

  • Look at the labels, milestones, and projects in the right sidebar. Associate the issue with the correct one(s).

  • Follow-up on old issues (ones with no activity for a month or more):

    • Ask (in a new comment, on Slack, in person) the assignee or last commenter what the status is.

    • Close or re-assign, with a comment that describes your reasoning.