From 932d2ef38584b2f4ae926fd484a24a4829fa6cc0 Mon Sep 17 00:00:00 2001 From: Jerry Xie <139205137+jerrysxie@users.noreply.github.com> Date: Wed, 3 Dec 2025 16:55:05 -0600 Subject: 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. --- CODEOWNERS | 5 +++++ CONTRIBUTING.md | 26 +++----------------------- LICENSE | 3 +-- 3 files changed, 9 insertions(+), 25 deletions(-) create mode 100644 CODEOWNERS diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 000000000..6e0f4c4c6 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,5 @@ +* @jamesmunns @felipebalbi + +# Any changes in the supply-chain folder needs approval +# from auditors as it relates to cargo vet +**/supply-chain @OpenDevicePartnership/crate-auditors \ No newline at end of file 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. 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 pull request so that the project team can discuss the situation with you. -# Contribution Guideline +## Commit Message -* For any new HAL driver added, please add corresponding test in the examples -* Format the code with `cargo fmt`. Or better yet, enable format on save in your IDE for rust source files. * Use meaningful commit messages. See [this blogpost](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) -# PR Etiquette +## PR Etiquette * Create a draft PR first * 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. -# Careful Use of `Unsafe` - -Working with embedded, using of `unsafe` is a necessity. However, please wrap unsafe code with safe interfaces to prevent `unsafe` keyword being sprinkled everywhere. - -# RFC Draft PR - -If you want feedback on your design or HAL driver early, please create a draft PR with title prefix `RFC:`. - -# Branch Naming Scheme - -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. - -# Clean Commit History - -We disabled squashing of commit and would like to maintain a clean commit history. So please reorganize your commits with the following items: - * Each commit builds successfully without warning from `rustc` or `clippy` - * Miscellaneous commits to fix typos + formatting are squashed - -# Regressions +## Regressions 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. diff --git a/LICENSE b/LICENSE index 479657c89..609bd42da 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2025 OEMWCSE +Copyright (c) 2025 Open Device Partnership Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -- cgit