Mathesar’s development happens on GitHub. We welcome contributions of all kinds!
We highly recommend joining our Matrix community and our developer mailing list before making contributions. This is where most of the core team’s conversations about building Mathesar happen.
Get Mathesar running locally.
Make sure to do this before moving on. If you need help, ask in Matrix, taking care to form specific questions that people can answer asynchronously.
Find an issue to work on.
restricted: ... labelstatus: ... label other than status: readyIf you want to work on something for which there is no GitHub issue open yet, create an issue and propose your change there. A Mathesar team member will evaluate your issue and decide whether we’ll accept a pull request for the issue.
(Optionally) Claim the issue.
If the Mathesar team has already merged one of your PRs, then you may wish to ear-mark the issue for yourself so that other do not work on it concurrently.
However, if you are brand new to Mathesar, we recommend skipping this step and making your changes without claiming the issue. (A core team member will assign the issue to you after you open a PR.) This recommendation is designed to reduce the overhead the core team has experienced from a high volume of contributors failing to follow through with their intent to submit PRs.
If you decide to claim the issue:
Please do not claim more than 2 issues concurrently before submitting PRs.
Begin making your changes.
master).Open a PR.
When you are ready for a core team member to review your changes, open a pull request (or mark your draft PR as ready for review). If you have already been corresponding with a core team member about the issue, then you may request a review from that person. Otherwise, you may leave your PR without any review requests and a core team member will assign someone to review it.
Address critique from PR review.
We encourage and appreciate code review by contributors. Feel free to review any open pull requests. Follow our code review guidelines.
Due to limited capacity, we are currently unable to accept design volunteers. Please return to this page for updates.
Please read through our Design section to learn more about our design process.