DataSpread is under active development. This guide contains information on the workflow for contributing to the Dataspread codebase. Parts of this guide are adapted from the Contributing Document of Lux
To setup Dataspread manually for development purposes, you should fork the Github repo and clone the forked version.
git clone https://github.com/USERNAME/dataspread-web.gitWhile you are working on your local repo, you also need to keep your fork synced and resolve conflicts locally. Please check out the Keep your fork synced and Sync a fork for more information.
You can commit your code and push to your forked repo. Once all of your local changes have been tested and formatted, you are ready to submit a pull request (PR). For Dataspread, we use the "Squash and Merge" strategy to merge in PR, which means that even if you make a lot of small commits in your PR, they will all get squashed into a single commit associated with the PR. Please make sure that comments and unnecessary file changes are not committed as part of the PR by looking at the "File Changes" diff view on the pull request page.
Once the pull request is submitted, the maintainer will get notified and review your pull request. They may ask for additional changes or comment on the PR. You can always make updates to your pull request after submitting it.
One pull request includes the full commit history. However, some commits are only for test purposes and do not contribute to the final commit. We encourage you to check out this doc to see how to submit a clean pull request with only meaningful commits.