commit a7fb6c310a765bed0a36a4aff33c3d3590dfa724 Author: tdk-opensource Date: Tue Feb 13 14:22:16 2024 +0100 Prepare repository diff --git a/.github/ISSUE_TEMPLATE/default-issue-template.md b/.github/ISSUE_TEMPLATE/default-issue-template.md new file mode 100644 index 0000000..6004e59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/default-issue-template.md @@ -0,0 +1,13 @@ +--- +name: Default issue template +about: Default issue template to notify maintainers team +title: '' +labels: '' +assignees: '' + +--- + +_Your text here_ + +--- +Notify: @tdk-invn-oss/motion-maintainers diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..a5d477e --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1 @@ +* @tdk-invn-oss/motion-maintainers diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6f9eced --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Contributing + +This repo is maintained by TDK Invensense, and write access to branches is restricted. +We still welcome your contributions to the project. Please read below to see how you can contribute. + +## Issues + +When creating an issue, please ping relevant GitHub Team as defined in file [CODEOWNERS](CODEOWNERS). +This will ensure our support team is properly notified. + +## Contribution flow + +To start contributing, you will first need to fork this repository. From your fork, you can create branches, make commits, etc. without restriction. + +When you would like to contribute something back to this repo, you should open a pull request to the `main` branch. +From here, a TDK Invensense member will review the code and decide whether to accept the contribution or not. + +In either case, the PR will not be directly merged. If the contribution is accepted, it will first be integrated into our internal repo and put through our normal release flow. +When the changes are made available in the TDK Invensense repo, you can then merge or rebase these changes into your own fork. + +Once the changes are released or rejected by TDK Invensense, the original PR will be closed by our support team. + +## Authorship + +It is important to include authorship information in the source files if your change is relevant enought and you want it to be preserved. + +You can simply include lines like the following on a per-file basis: +``` +// Contributors: +// Copyright: (c) , (c) +``` + +Or you can include it at a finer scope if you wish.