Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

18 lines (14 loc) · 1.36 KB
Raw

General Help

General help with ReQL questions can be found on:

  • Gitter: Primary means of getting help is on Gitter If you don't receive the invite, check your spam folder.

Pull Requests

Here are some helpful guidelines to keep in mind when contributing. While following them isn't absolutely required, it does help everyone to accept your pull-requests with maximum awesomeness.

  • ✔️ CONSIDER adding a unit test if your PR resolves an issue.
  • ✔️ DO keep pull requests small so they can be easily reviewed.
  • ✔️ DO make sure unit tests pass.
  • ✔️ DO make sure any public APIs are XML documented. We don't need no stinkin' CS1591. =)
  • ✔️ DO make sure not to introduce any compiler ⚠️ warnings. We keep it at 0️⃣ 'cuz that's how we roll. 💵
  • ❌ AVOID breaking the continuous integration build.
  • ❌ AVOID making significant changes to the driver's overall architecture. We'd like to keep this driver in-sync with the overall architecture of the Java driver so both projects benefit from bug fixes and new features.