Mathesar Team Workflow¶
Mathesar work happens on GitHub. We create GitHub issues to track everything we’re working on for both design and code.
We track our tasks in the Mathesar GitHub project.
Creating pull requests¶
- All pull requests should follow the code review rules.
- All external contributors need to open an issue first before creating a pull request.
- Team members are allowed to create PRs for minor changes without a related issue.
In case of breaking API changes¶
This process is only valid until we have a first user. Then, it should be reviewed.
- Try to implement API changes in ways that do not cause breakage.
In case that’s unavoidable:
- Finish the changes to the API, and open a PR. This should be well documented, with a clear description of what the breaking changes are.
- Contact a front end dev directly, and ask them to look at the PR. At this point, they should just assess whether the needed front end changes are quick, easy, and feasible with a short turnaround time.
- Go through the normal review process for the back end code and API form to the point where all are happy with the API response format.
- If the front end devs are able to make appropriate front end changes easily and quickly, they should do so in the same PR.
- If not (i.e., if front end devs are busy, if it’s too complicated, or if the back end PR’s unmerged state starts to block too many things): merge the PR with a big warning (i.e., a comment @’ing multiple people).
- File an urgent bug describing the changes to the back end, and the needed changes to the front end.
For a list of public repos and other resources, see GitHub.
- Mathesar GitHub project that organizes our open issues
These resources are only available to the Mathesar core or community team at the moment.
- The Mathesar Ansible repository contains a playbook that deploys our staging server.
- The Mathesar “staging” server is a deployed version of the latest
master. The username and password to access it are located in 1Password.
- The Mathesar private notes repository contains notes that are private to the core team.
- The Mathesar scripts repository contains a bunch of random scripts useful for Mathesar workflows.