Skip to content
This repository has been archived by the owner on Jan 13, 2022. It is now read-only.

Contributing to Scribe

Jump to bottom
facebook edited this page Sep 13, 2010 · 4 revisions

Found a bug?

If you’re running Scribe and have found a bug, you should make sure to include as much information as possible such as what version you’re running, the version of Linux you’re using, error logs, and any sort of configuration information that could be useful. Please search both the issue tracker and mailing list to see if others have run into a similar problem. If so, you don’t need to open a new issue!

After searching the issue tracker and the mailing list, please use the issue tracker to submit your bug report.

Wrote a patch?

Awesome! We prefer unified diffs which can be generated using the git diff or diff -u commands. (See learn.GitHub for a real tutorial.) Here’s what you should do before submitting your patch:

  1. Make you’re creating the patch off of the latest version of the Scribe source.
  2. Test Scribe to ensure that it still runs correctly with your code changes.
  3. Ensure that Scribe still passes its unit tests with your code changes. A bonus would even be writing new unit tests (or updating existing ones) to support your changes.
  4. Generate your patch file and save it to a file. For example:
    git diff > whizbangs.patch

While bugs are submitted via the issue tracker and GitHub supports pull requests, we strongly prefer patches emailed to the mailing list. This makes it easier for all of the developers to review your patch, ask questions about it, and generally produce higher quality software.

When you send your patch to the mailing list, please prefix your subject with [patch] and include the following information:

  1. A few sentence description of what your patch does
  2. What you did to test your patch
  3. The patch itself!

If you’re working on a public GitHub repo, please use git rebase to squash your various commits into a single commit and send a link to that along with your patch. (You may want to make a new branch with this squashed commit.) That single commit should be identical to the patch file you send. You might get a few questions, but mainly thanks for the patch!

While the Apache License covers the submission of contributions, we may ask you (or your company) to sign a Facebook Contributors License Agreement. We use the exact same agreement as the Apache Software Foundation and Google.

Clone this wiki locally