bcgov / bcgov/api-guidelines

From Dig Platforms & Data - policy perspective

Đang mở
#15 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
feedback
Ngôn ngữ chính
Không có dữ liệu ngôn ngữ
Star
34
Fork
10
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

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

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.