From ab36559552b1c36a259d4278ca86edfc44201279 Mon Sep 17 00:00:00 2001 From: Joachim Krech Date: Tue, 15 Jun 2021 08:37:32 +0200 Subject: [PATCH 1/3] Adding License, Contributions and Issues to readme --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index da29d26..ef42502 100644 --- a/README.md +++ b/README.md @@ -36,3 +36,45 @@ $ git clone https://github.com/open-cmsis-pack/vidx2pidx $ cd vidx2pidx $ make ``` +## License + +vidx2pidx is licensed under Apache 2.0. + +## Contributions and Pull Requests + +Contributions are accepted under Apache 2.0. Only submit contributions where you have authored all of the code. + +### Issues and Labels + +Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pack/vidx2pidx/issues) +to report misbehavior (i.e. bugs) or start discussions about enhancements. This +is your best way to interact directly with the maintenance team and the community. +We encourage you to append implementation suggestions as this helps to decrease the +workload of the very limited maintenance team. + +We will be monitoring and responding to issues as best we can. +Please attempt to avoid filing duplicates of open or closed items when possible. +In the spirit of openness we will be tagging issues with the following: + +- **bug** – We consider this issue to be a bug that will be investigated. + +- **wontfix** - We appreciate this issue but decided not to change the current behavior. + +- **enhancement** – Denotes something that will be implemented soon. + +- **future** - Denotes something not yet schedule for implementation. + +- **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work. + +- **question** – We have further questions to this issue. Please review and provide feedback. + +- **documentation** - This issue is a documentation flaw that will be improved in future. + +- **review** - This issue is under review. Please be patient. + +- **DONE** - We consider this issue as resolved - please review and close it. In case of no further activity this issues will be closed after a week. + +- **duplicate** - This issue is already addressed elsewhere, see comment with provided references. + +- **Important Information** - We provide essential informations regarding planned or resolved major enhancements. + From e3303bf057221b8d03ca5c1ef98d3b863ae0a46b Mon Sep 17 00:00:00 2001 From: Joachim Krech <8290187+jkrech@users.noreply.github.com> Date: Sun, 7 Sep 2025 15:49:59 +0200 Subject: [PATCH 2/3] fix linting observations --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 67a44b4..f3b6259 100644 --- a/README.md +++ b/README.md @@ -73,9 +73,9 @@ Now the generated `index.pidx` can be used with cpackget to validate that all li ## Clone and Build ```bash -$ git clone https://github.com/open-cmsis-pack/vidx2pidx -$ cd vidx2pidx -$ make +git clone https://github.com/open-cmsis-pack/vidx2pidx +cd vidx2pidx +make ``` ## License @@ -92,7 +92,7 @@ Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pac to report misbehavior (i.e. bugs) or start discussions about enhancements. This is your best way to interact directly with the maintenance team and the community. We encourage you to append implementation suggestions as this helps to decrease the -workload of the very limited maintenance team. +workload of the very limited maintenance team. We will be monitoring and responding to issues as best we can. Please attempt to avoid filing duplicates of open or closed items when possible. @@ -101,21 +101,24 @@ In the spirit of openness we will be tagging issues with the following: - **bug** – We consider this issue to be a bug that will be investigated. - **wontfix** - We appreciate this issue but decided not to change the current behavior. - -- **enhancement** – Denotes something that will be implemented soon. + +- **enhancement** – Denotes something that will be implemented soon. - **future** - Denotes something not yet schedule for implementation. -- **out-of-scope** - We consider this issue loosely related to CMSIS. It might by implemented outside of CMSIS. Let us know about your work. - +- **out-of-scope** - We consider this issue loosely related to CMSIS. +It might by implemented outside of CMSIS. Let us know about your work. + - **question** – We have further questions to this issue. Please review and provide feedback. - **documentation** - This issue is a documentation flaw that will be improved in future. - **review** - This issue is under review. Please be patient. - -- **DONE** - We consider this issue as resolved - please review and close it. In case of no further activity this issues will be closed after a week. + +- **DONE** - We consider this issue as resolved - please review and close it. +In case of no further activity this issues will be closed after a week. - **duplicate** - This issue is already addressed elsewhere, see comment with provided references. - **Important Information** - We provide essential informations regarding planned or resolved major enhancements. + From e216f3c9492436019eabfeef9df0a072f0a26f21 Mon Sep 17 00:00:00 2001 From: Joachim Krech <8290187+jkrech@users.noreply.github.com> Date: Sun, 7 Sep 2025 15:51:57 +0200 Subject: [PATCH 3/3] Update README.md --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index f3b6259..8166960 100644 --- a/README.md +++ b/README.md @@ -121,4 +121,3 @@ In case of no further activity this issues will be closed after a week. - **duplicate** - This issue is already addressed elsewhere, see comment with provided references. - **Important Information** - We provide essential informations regarding planned or resolved major enhancements. -