Skip to content

Latest commit

 

History

History
34 lines (19 loc) · 1.83 KB

Contributing.md

File metadata and controls

34 lines (19 loc) · 1.83 KB
Raw

How to contribute

Here are some important resources:

  • Email: Dr. Bonham-Carter ([email protected]), or Jordan Wilson ([email protected]).
  • Bugs? Use the GitHub Issue Tracker, unless the issue is security related, in which case email either of the two people above.

Testing

We only have a handful of R functions. Please write examples for new code you create.

Submitting changes

Please send a GitHub Pull Request to privacy with a clear list of what you've done (read more about pull requests). Please make sure all of your commits are atomic (one feature per commit).

Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:

$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Privacy will generally not be accepted.

Do you want to contribute to the Privacy documentation?

You can help improve the Privacy guides by making them more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest edge Rails.

To do so, make changes to privacy guides source files (located here on GitHub) or comments in source code. Then open a pull request to apply your changes to the master branch.

Do you have questions about the source code?

Please email either Dr. Bonham-Carter or Jordan Wilson for any and all questions related to the privacy repository.