Skip to content

Contributing

Derek Bruening edited this page Dec 9, 2017 · 9 revisions

Contributing to Dr. Memory

We welcome contributions to Dr. Memory. We do not require a formal contributor license agreement or transfer of copyright. Contributions are implicitly assumed to be offered under terms of Dr. Memory's primary LGPL 2.1 license as well as a BSD license.

If you would like to contribute an individual source code change to Dr. Memory by having an existing developer commit it, submit a patch following our Code Review process for non-project members.

If you would like to become a project member and contribute directly, please contact us. Normally you would first submit a few small patches as a non-member to demonstrate your work. When you become a member, by accepting write access to the repository you will also be implicitly agreeing to abide by all policies and conventions of the Dr. Memory project. This includes agreeing to submit all changes to at least one other project member for code review and to abide by reasonable requests for modifications to your proposed changes.

Please read our wiki pages, including Workflow, Code Reviews, and Code Style before writing new Dr. Memory code.

Project Ideas

See Projects for a list of suggested projects.

Guidelines for Submitting Code Changes

Some pointers to get started once you've signed the Contributor License Agreement:

  • Check out and work on the code following our Workflow
  • Follow our coding style conventions: Code Style
  • Build and run the tests to test new code and ensure it works before submitting as a patch: Code Reviews, Test Suite
  • Submit patches to our online review system and cc the developer email list: Code Reviews
  • The DynamoRIO guidelines regarding staging large commits and how to write commit messages apply as well
Clone this wiki locally