Contributing to the Fitbit OS SDK

Overview

Want to contribute to the Fitbit OS SDK on Github? Great! There's just a few things you should know first.

What Kind of Contributions Can I Make?

In general, it's best to start by filing an issue for the bug you'd like to fix, or feature you'd like to add.

If you're adding a new feature, please file an issue describing your proposal so we can discuss it and make sure you're on the right track before you put a lot of effort into implementing it.

We welcome all PRs that aim to make our codebase or products better. Even simple things such as typo fixes are appreciated!

If you want to help, but you're not sure what to work on, our issue tracker might have some ideas for areas where we're looking for help!

Licensing

Our project is licensed under a BSD-3-Clause license. By contributing you agree to Developer Certificate of Origin (DCO). This document is a simple statement that you, as a contributor, have the legal right to make the contribution.

Once you have read and agree to the DCO, you just need to add this line to each Git commit message:

Signed-off-by: Jane Smith <jane.smith@example.com>

If you set your user.name and user.email Git configs, you can sign your commit automatically with:

git commit -s

You must use your real name. Pseudonyms and anonymous contributions are not permitted, sorry!

How Do I Submit My Change?

1. Submit an issue describing your proposed change or bug you're fixing.
2. We'll try to respond to your issue quickly with feedback.
3. Fork the repo, develop and test your change.
4. Submit a pull request against the master branch.
5. Once all tests on CI pass and a maintainer has approved your change, you can merge it to master! 🎉

Reporting Security Issues

Please submit security issues to security@fitbit.com, not as a GitHub issue.

Join the Community!

Join in the discussion with our developer community via the Community Forums and Discord!

Developer Certificate of Origin (DCO)

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.