Skip to content
Josse Van Delm edited this page Aug 14, 2023 · 7 revisions

Welcome to the xdsl wiki!

Contribution Guide

An incomplete list of contribution guidelines:

  • if you would like to start working on an issue, please let us know by commenting on it or pinging us on Zulip
    • the Zulip is an especially good place to get a discussion going on good approaches to get started
    • it is really helpful to add the conclusion of any offline discussions to the issue
  • when creating a branch, please prefix the branch name like so: "your-name/short-issue-description"
    • this lets us keep a neat hierarchy of branches in the repository
  • if you are working on something related on an open PR, or would like to help move a PR forward, please let comment on the PR to let us know
    • please don't push directly to a branch created by another contributor without a prior discussion with them
  • when opening a PR, please follow the prefix guidelines
    • sometimes a PR will affect only one dialect, please add it in parentheses to the title, like so:
    • dialects: (arith) add custom syntax or interpreter: (arith) add mulf implementation
  • please try to address or reply to all comments on a PR
    • this lets us minimise the chances of missing something important in a proposed change