diff options
| author | James Munns <[email protected]> | 2025-12-04 18:46:39 +0100 |
|---|---|---|
| committer | James Munns <[email protected]> | 2025-12-04 18:47:31 +0100 |
| commit | c3bc8fe8c0db112e5f2f66580104fc49b02890d2 (patch) | |
| tree | eea7adc15021697ea980289edd6235daaa12d6ee /embassy-mcxa/CONTRIBUTING.md | |
| parent | 5182b2ed54f991b40b45fd2de75f597358ff9c3e (diff) | |
| parent | 277ab0d2e8714edf37a0ee84cda1059d9944ecef (diff) | |
Import embassy-mcxa repo
Merge remote-tracking branch 'james-e-mcxa/james/upstream' into james/upstream-mcxa
Diffstat (limited to 'embassy-mcxa/CONTRIBUTING.md')
| -rw-r--r-- | embassy-mcxa/CONTRIBUTING.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/embassy-mcxa/CONTRIBUTING.md b/embassy-mcxa/CONTRIBUTING.md new file mode 100644 index 000000000..f10eb5be9 --- /dev/null +++ b/embassy-mcxa/CONTRIBUTING.md | |||
| @@ -0,0 +1,28 @@ | |||
| 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 | ## Regressions | ||
| 27 | |||
| 28 | 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. | ||
