diff options
| author | Jerry Xie <[email protected]> | 2025-12-03 16:55:05 -0600 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-12-03 14:55:05 -0800 |
| commit | 932d2ef38584b2f4ae926fd484a24a4829fa6cc0 (patch) | |
| tree | d2cffd1570dfb5baaf7bad09895831e70ec5d02d /CONTRIBUTING.md | |
| parent | b75a6222e892cc58543b30f231b60dedaa0a5f5d (diff) | |
Miscellaneous updates before public release (#87)
This pull request introduces several updates focused on project
ownership, licensing, and contribution guidelines. The main changes
clarify code ownership, update the project's copyright, and reorganize
the contributing documentation for better clarity.
**Project Ownership and Licensing:**
* Added a new `CODEOWNERS` file specifying maintainers and requiring
auditor approval for changes in the `supply-chain` folder, which relates
to cargo vet.
* Updated the copyright in the `LICENSE` file from "OEMWCSE" to "Open
Device Partnership".
**Documentation and Contribution Guidelines:**
* Reorganized the `CONTRIBUTING.md` file by restructuring headings,
clarifying commit message and PR etiquette sections, and removing
redundant or outdated guidelines for branch naming, use of `unsafe`, and
commit history.
**Minor Cleanups:**
* Removed an unnecessary trailing blank line from the end of the
`LICENSE` file.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 3 insertions, 23 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7c8289a58..f10eb5be9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md | |||
| @@ -14,35 +14,15 @@ you have the right to submit those contributions under those terms. | |||
| 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 | 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. | 15 | pull request so that the project team can discuss the situation with you. |
| 16 | 16 | ||
| 17 | # Contribution Guideline | 17 | ## Commit Message |
| 18 | 18 | ||
| 19 | * For any new HAL driver added, please add corresponding test in the examples | ||
| 20 | * Format the code with `cargo fmt`. Or better yet, enable format on save in your IDE for rust source files. | ||
| 21 | * Use meaningful commit messages. See [this blogpost](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) | 19 | * Use meaningful commit messages. See [this blogpost](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) |
| 22 | 20 | ||
| 23 | # PR Etiquette | 21 | ## PR Etiquette |
| 24 | 22 | ||
| 25 | * Create a draft PR first | 23 | * Create a draft PR first |
| 26 | * 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. | 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. |
| 27 | 25 | ||
| 28 | # Careful Use of `Unsafe` | 26 | ## Regressions |
| 29 | |||
| 30 | Working with embedded, using of `unsafe` is a necessity. However, please wrap unsafe code with safe interfaces to prevent `unsafe` keyword being sprinkled everywhere. | ||
| 31 | |||
| 32 | # RFC Draft PR | ||
| 33 | |||
| 34 | If you want feedback on your design or HAL driver early, please create a draft PR with title prefix `RFC:`. | ||
| 35 | |||
| 36 | # Branch Naming Scheme | ||
| 37 | |||
| 38 | For now, we're not using forks. Eventually a personal fork will be required for any PRs to limit the amount of people with merge access to the main branch. Until that happens, please use meaningful branch names like this `user_alias/feature` and avoid sending PRs from branches containing prefixes such as "wip", "test", etc. Prior to sending a PR, please rename the branch. | ||
| 39 | |||
| 40 | # Clean Commit History | ||
| 41 | |||
| 42 | We disabled squashing of commit and would like to maintain a clean commit history. So please reorganize your commits with the following items: | ||
| 43 | * Each commit builds successfully without warning from `rustc` or `clippy` | ||
| 44 | * Miscellaneous commits to fix typos + formatting are squashed | ||
| 45 | |||
| 46 | # Regressions | ||
| 47 | 27 | ||
| 48 | 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. | 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. |
