The simplest way to give back to MediaDrop is to report bugs as you find them!
Please post issues to our issue tracker on Github.
You can always post to our community forums if you aren’t sure if its a bug or not.
To build the documentation you must have Sphinx and Pygments installed. They were probably installed when you first installed MediaDrop, but just in case, here’s how to install them. (This example assumes that you’re using a virtualenv called mediadrop_env, as outlined in the install instructions.)
# As always, don't forget to work in your virtualenv $ source mediadrop_env/bin/activate $ easy_install Sphinx Pygments # Build the HTML docs with sphinx $ cd doc $ make html
Patches to the documentation can be submitted in the same way as patches to code, discussed below.
Generally we request that you create an issue in our issue tracker for any patch you’d like to submit. It helps us stay organized in the long run.
Our Git repository is hosted over at Github and one of their handy features is forking. This perfect for submitting large features, or anything with two or more people working on it. There is an excellent tutorial on their site, so we won’t explain it here. Pull requests can be sent to Nathan Wright.
We’ll explain how to do this if you’ve cloned our public Git repository on your local machine, without using Github forking. This is perfect for bugfixes and smaller features, where only one person is working on it.
# Getting a copy of our git repository (if you haven't already): $ git clone git://github.com/mediadrop/mediadrop.git # Create a new branch and switch to it: $ git checkout -b your_local_branch
Make your changes and commit them. Once that’s done, you’re ready to create a patch for submission:
# Make sure you have the latest changes from our repository $ git fetch # Move your branch on top of our latest changes $ git rebase origin/master # This creates a file your_patch from the commits in your_local_branch $ git format-patch --stdout origin/master.. > your_patch
Attach the your_patch file to an issue describing the problem and the fix.