syncwith.us

Contributing to SD

Want to help out with SD? Great! We're always interested in new contributors, and have plenty of tasks that new people can help out with. Help make SD work better for you.

Increasing test coverage

We currently have pretty good test coverage, but it can always be better. We're publishing coverage analysis reports for Prophet here and SD here. New tests that increase our coverage are gratefully accepted.

Writing foreign replica syncs

If you want to write a foreign replica module for an issue tracker that SD doesn't support yet, we'd love to hear from you.

Squashing bugs

If there's anything from the bug list that catches your interest, or if you find a new bug, feel free to fix it and submit a patch. If it's a feature-wishlist bug that requires design alterations, however, you may wish to talk to us first to make sure your ideas and ours are in line.

Documentation

We're currently lacking a good tutorial, screenshots, and other bling to show people and help them use SD. Some ideas for things we're looking for here can be found by searching for tickets assigned to the "docs" component (from a checked out copy of SD's git repository, with the SD bug replica cloned:

git sd ticket search -- component=docs 'status=~new|open'

Submitting patches

So, you've written a patch. Rock on. There are a couple of ways you can submit it to us.

One way is to fork our repository on GitHub and submit a pull request for a branch containing your changes. Another is to use git format-patch and email the patch to the mailing list, prophet@bestpractical.com or upload it somewhere and link to it from IRC.

When submitting patches, try to have good commit messages and separate your patches into logical units. But don't worry about being perfect—the worst that can happen is that we ask for an amended patch with changes.

Creative Commons License
The content of this website, created collaboratively by Prophet's developers, is licensed under a Creative Commons Attribution 3.0 United States License.