From Dig Platforms & Data - policy perspective
- Dominant language
- No language data
- Stars
- 34
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
Hi Ruonan,
Reviewing from a non-technical perspective, I have a few comments:
- Consider including a Definitions section, or adding a few defs within the document. I noted a few terms that may need a description to ensure the document is widely accessible: BC Data Catalogue, OAUTH token, CI/CD pipeline.
- "API Store" - suggest this term be replaced with "BC Government API Registry"
- open source software - a few tools are mentioned in the guide and, to ensure employees are aware of requirements for acquiring open source software, consider including a link to the [Guidelines on the Use of Open Source Software](https://www2.gov.bc.ca/assets/gov/government/services-for-government-and-broader-public-sector/information-technology-services/standards-files/guidelines_on_the_use_of_open_source_software_2016.pdf), and the [BC Open Source Development Employee Guide](https://github.com/bcgov/BC-Policy-Framework-For-GitHub/blob/master/BC-Open-Source-Development-Employee-Guide/README.md) for Github contributions. Also suggest consistently including hyperlinks to promoted tools (e.g."Postman" and "curl").
Thanks !
Julie
Contributor guide
Assessment
This issue has not been assessed yet.