Open-source the project / repo.
Opened this issue · 0 comments
nfreear commented
Hi,
Here are the steps which I think need to be taken to open-source this project / repo :~
- – Agree open-sourcing in principle (agreed in principle at meeting on 24th August 2021, by Tony S. in RES, Tim C. and Kevin M.);
- – Agree license – permissive MIT ? (to match e.g. https://github.com/Microsoft/BotFramework-WebChat);
- – Agree repo. location – https://github.com/IET-OU/ ;
- – Agree package name. Suggestions: "
patient-speech-recognizer
" OR "adaptive-speech-recognizer
" (US spelling?) (E.g. https://github.com/IET-OU/patient-speech-recognizer and https://npmjs.com/package/patient-speech-recognizer ) - – Replace "
__TODO_NAME__
" with package name (package.json, README.md, index.html) - – Replace "
__TODO_LICENSE__
" with license ID ("MIT
" ?) (package.json, README.md) - – Add "
LICENSE.txt
" file to repo. with text from, e.g. mit-license.org | choosealicense.com/.. – Add: "Copyright © 2021 The Open University (IET).
" to theLICENSE
; - – Review the "version" field in
package.json
– I suggest "2.0.1
"; - – Review "description", "keywords", "author", "contributors", "repository" and other fields in
package.json
(See: NPM docs:package.json
); - – When happy, commit then run
git tag 2.0.1
; - – Experiment with
npm publish --dry-run
(See: NPM docs:npm publish
); - – Finally, run
npm publish
!
Best of luck!
Compare with: