diff options
| author | Jeff Glaum <[email protected]> | 2025-09-08 15:15:38 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-09-08 15:15:38 -0700 |
| commit | 47e383545f4aac3bfaec0563429cc721540e665a (patch) | |
| tree | 14a65826c3b38cd86bfa26d28866c56835e3e8e3 /CONTRIBUTING.md | |
Initial commit
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..c45bc8e43 --- /dev/null +++ b/CONTRIBUTING.md | |||
| @@ -0,0 +1,35 @@ | |||
| 1 | # Contributing to Open Device Partnership | ||
| 2 | |||
| 3 | The Open Device Partnership project welcomes your suggestions and contributions! Before opening your first issue or pull request, please review our | ||
| 4 | [Code of Conduct](CODE_OF_CONDUCT.md) to understand how our community interacts in an inclusive and respectful manner. | ||
| 5 | |||
| 6 | ## Contribution Licensing | ||
| 7 | |||
| 8 | Most of our code is distributed under the terms of the [MIT license](LICENSE), and when you contribute code that you wrote to our repositories, | ||
| 9 | you agree that you are contributing under those same terms. In addition, by submitting your contributions you are indicating that | ||
| 10 | you have the right to submit those contributions under those terms. | ||
| 11 | |||
| 12 | ## Other Contribution Information | ||
| 13 | |||
| 14 | If you wish to contribute code or documentation authored by others, or using the terms of any other license, please indicate that clearly in your | ||
| 15 | pull request so that the project team can discuss the situation with you. | ||
| 16 | |||
| 17 | ## Commit Message | ||
| 18 | |||
| 19 | * Use meaningful commit messages. See [this blogpost](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | ||
| 20 | |||
| 21 | ## PR Etiquette | ||
| 22 | |||
| 23 | * Create a draft PR first | ||
| 24 | * Make sure that your branch has `.github` folder and all the code linting/sanity check workflows are passing in your draft PR before sending it out to code reviewers. | ||
| 25 | |||
| 26 | ## Clean Commit History | ||
| 27 | |||
| 28 | We disabled squashing of commit and would like to maintain a clean commit history. So please reorganize your commits with the following items: | ||
| 29 | |||
| 30 | * Each commit builds successfully without warning | ||
| 31 | * Miscellaneous commits to fix typos + formatting are squashed | ||
| 32 | |||
| 33 | ## Regressions | ||
| 34 | |||
| 35 | When reporting a regression, please ensure that you use `git bisect` to find the first offending commit, as that will help us finding the culprit a lot faster. | ||
