aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CODEOWNERS5
-rw-r--r--CONTRIBUTING.md26
-rw-r--r--LICENSE3
3 files changed, 9 insertions, 25 deletions
diff --git a/CODEOWNERS b/CODEOWNERS
new file mode 100644
index 000000000..6e0f4c4c6
--- /dev/null
+++ b/CODEOWNERS
@@ -0,0 +1,5 @@
1* @jamesmunns @felipebalbi
2
3# Any changes in the supply-chain folder needs approval
4# from auditors as it relates to cargo vet
5**/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.
14If you wish to contribute code or documentation authored by others, or using the terms of any other license, please indicate that clearly in your 14If you wish to contribute code or documentation authored by others, or using the terms of any other license, please indicate that clearly in your
15pull request so that the project team can discuss the situation with you. 15pull 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
30Working 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
34If 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
38For 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
42We 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
48When 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. 28When 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 @@
1MIT License 1MIT License
2 2
3Copyright (c) 2025 OEMWCSE 3Copyright (c) 2025 Open Device Partnership
4 4
5Permission is hereby granted, free of charge, to any person obtaining a copy 5Permission is hereby granted, free of charge, to any person obtaining a copy
6of this software and associated documentation files (the "Software"), to deal 6of 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
19LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 19LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 20OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21SOFTWARE. 21SOFTWARE.
22