Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

105 lines (73 loc) · 3.27 KB
Raw

Contributing Guidelines

This document describes in general terms how to contribute to the Unum SDK.

Get started

Thanks for your interest in contributing to Unum SDK! We hope to make contributing as simple as possible-- don't worry too much about protocol around opening an issue or Pull Request (aka PR).

There is only one absolute requirement: Treat everyone with respect!

Report a vulnerability

Contact us directly by mail at [email protected] to report security-related or otherwise sensitive matters.

Encode your message with the Minim Labs public key (0x5512FA98E0424563), if desired.

Open an Issue

Don't sweat it, just open an issue on our GitHub.

We have a few issues templates to help streamline issue reporting, but if none of the templates fit your situation, feel free to improvise!

Open a Pull Request

In general, follow these steps when opening a pull request:

  1. Fork the Unum SDK repository on GitHub
  2. Clone your fork to your local machine 
    git clone [email protected]:YOURUSERNAME/unum-sdk
cd unum-sdk
  3. Check out a new branch -- name it anything! 
    git checkout -b patch-1
  4. Make your changes, commit, and push to your fork on GitHub 
    git add -u
git commit -m "Try to write a coherent commit message"
git push origin patch-1
  5. Open a Pull Request on the main Unum SDK GitHub repository

When opening a pull request, please consider:

  • Every pull request must pass CI before being merged, and merges are performed by rebase-and-squashing.
  • Expect to be requested to make at least a couple of changes on your pull requests-- please take no offense at these requests! Code reviews can be high-tension and high-emotion, but we'll do our best to be diplomatic about our requests. Do not be afraid to disagree or ask for further explanation or justification, however!

Helpful things to include

Whether you're opening an issue or a PR, it is helpful for us to know:

  • Platform you're building the SDK on (if applicable)
  • Platform you're running Unum on
  • Version of the Unum SDK you're using

Other things to be aware of

  • Unum SDK is licensed under Apache 2.0 and should not contain any GPL- licensed code. Any contributions are expected to be original works unless otherwise explicitly noted and attributed.
  • Unum SDK is based on an internal Minim project and should remain structurally and technically compatible-- we don't recommend drastic changes without chatting with us first!
  • If you have a negative experience, please call it out so that it can be addressed. We aim to never intentionally belittle, insult, or mock, but to err is human-- let us know so we can adjust our behavior.

Happy Contributing!

Unum SDK is an open source project by Minim. Send us mail or check out our blog!