Skip to content

Latest commit

 

History

History
34 lines (23 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.54 KB
Raw

How to contribute

We'd love to accept your patches and contributions to this project. There are a just a few small guidelines you need to follow.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in.

  3. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  4. Finally, push the commits to your fork and submit a pull request.

Other notes on code organization

Currently, everything is defined in the main Q class. These services map directly to how the Force.com SOQL and SOSL Reference is organized, so use that as your guide for where to put new methods.