Skip to content

Commit abc1fb1

Browse files
authored
Adding License, Contributions and Issues to readme (#105)
* Adding License, Contributions and Issues to readme * fix linting observations * Update README.md
1 parent 478960e commit abc1fb1

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,55 @@ Now the generated `index.pidx` can be used with cpackget to validate that all li
6969
- invoke `cpackget init ./index.pidx -R ./pack_root_test` to use the generated index.pidx in
7070
pack_root_test/.Web/index.pidx
7171
- invoke `cpackget --public -R /pack_root_test` to list all latest public pack versions
72+
73+
## Clone and Build
74+
75+
```bash
76+
git clone https://github.com/open-cmsis-pack/vidx2pidx
77+
cd vidx2pidx
78+
make
79+
```
80+
81+
## License
82+
83+
vidx2pidx is licensed under Apache 2.0.
84+
85+
## Contributions and Pull Requests
86+
87+
Contributions are accepted under Apache 2.0. Only submit contributions where you have authored all of the code.
88+
89+
### Issues and Labels
90+
91+
Please feel free to raise an [issue on GitHub](https://github.com/Open-CMSIS-Pack/vidx2pidx/issues)
92+
to report misbehavior (i.e. bugs) or start discussions about enhancements. This
93+
is your best way to interact directly with the maintenance team and the community.
94+
We encourage you to append implementation suggestions as this helps to decrease the
95+
workload of the very limited maintenance team.
96+
97+
We will be monitoring and responding to issues as best we can.
98+
Please attempt to avoid filing duplicates of open or closed items when possible.
99+
In the spirit of openness we will be tagging issues with the following:
100+
101+
- **bug** – We consider this issue to be a bug that will be investigated.
102+
103+
- **wontfix** - We appreciate this issue but decided not to change the current behavior.
104+
105+
- **enhancement** – Denotes something that will be implemented soon.
106+
107+
- **future** - Denotes something not yet schedule for implementation.
108+
109+
- **out-of-scope** - We consider this issue loosely related to CMSIS.
110+
It might by implemented outside of CMSIS. Let us know about your work.
111+
112+
- **question** – We have further questions to this issue. Please review and provide feedback.
113+
114+
- **documentation** - This issue is a documentation flaw that will be improved in future.
115+
116+
- **review** - This issue is under review. Please be patient.
117+
118+
- **DONE** - We consider this issue as resolved - please review and close it.
119+
In case of no further activity this issues will be closed after a week.
120+
121+
- **duplicate** - This issue is already addressed elsewhere, see comment with provided references.
122+
123+
- **Important Information** - We provide essential informations regarding planned or resolved major enhancements.

0 commit comments

Comments
 (0)