Sprint 3 - Cleanup
API
-
renaming bin to commands [AF] -
renaming devtools to tools [SJ] renaming docs? to documentation? (weak)-
renaming spec to specification [KRW] -
add README in spec directory [SJ] - https://gitlab.com/LibreFoodPantry/client-solutions/theas-pantry/guestinfosystem/community/-/issues/65
-
.gitignore seems to be missing file types (e.g. common operating system files) [SJ] -
add license for content [KRW] -
README.md [SJ] - line 1 missing "is"
- Developer Guide Getting Started
- item 5 "see Development Infrastructure"
(later) item 6 rename cheatsheet to workflow? rename link
- #66 (closed)
-
.devcontainer/devcontainer.json - remove comments lines 31-32, 41-42 [KRW] -
.gitlab/merge_request_templates/squash.md [KRW] -
rewrite line before commit messages to include link to conventional commits, explain that what is below is an example. -
move list of types out of version control to here -
period after close your editor -
put commands in code blocks with "run the following command"
-
-
devtools/squash/bin/ -
run.sh check to make sure it is not main (message should say check out your feature branch), and "Are you sure?" [SJ] -
rename to squash.sh premerge-squash.sh
-
-
devtools rename builder->build, commitlint-branch->lint-commits-on-branch, lint-pkg-json->lint-package-json, open-api-validator->validate-openapi, squash.sh->premerge-squash.sh [RK] -
deliver: docs remove changelog, move openapi.yaml to client/ [SJ] -
devtools - change all bin->commands and change all references in docs and gitlab-ci.yml [AF] -
devtools/*/README add "For CI usage" add the contents of this file to your top-level gitlab-ci.yml file modifying path, mention config files -
build -
deliver -
lint-commits-on-branch -
lint-dockerfiles -
lint-js-json-vue-files -
lint-markdown-files -
lint-markdown-links -
lint-package-json -
lint-shell-scripts -
premerge-squash -
validate-openapi
-
-
devtools/squash README add how to use the tests -
lint-shell-scripts/run.sh needs some explanation in comments about what is going on OR rewrite into a script that we pass to docker run -
lint-pkg-json/entrypoint should be one line (line 14) -
link-json-files/entrypoint should be one line (line 14) -
lint-dockerfiles/run.sh needs some explanation in comments about what is going on OR rewrite into a script that we pass to docker run -
deliver/deliver-openapi.sh needs better explanation or cleanup -
deliver/README dependent on build -
deliver/releaserc.yaml add comment explaining why we are using yaml instead of json, and an example of correspondence between a plugin config in json to yaml commitlint-branch/entrypoint could be cleaned up-
docs/developer/* need to be looked over and updated - there are things that are out-of-date or don't exist anymore
Edited by Stoney Jackson