skills.rest
contentstack
contentstackOFFICIAL
Explore all skills by this author →
WebsiteGitHub

code-review

Review DataSync filesystem content store PRs for API stability and compatibility.

1|Updated Jan 3, 2019
Search Tags:#testing#api#compatibility#filesystem#code-review#datasync#content-store
One-click install
npx skills add https://github.com/contentstack/datasync-content-store-filesystem --skill code-review-contentstack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: code-review
Source: https://github.com/contentstack/datasync-content-store-filesystem/tree/main/skills/code-review
Command: npx skills add https://github.com/contentstack/datasync-content-store-filesystem --skill code-review-contentstack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Review PRs touching the DataSync filesystem content store to ensure API exposure is stable, compatibility is preserved across versions, tests cover critical behaviors, and terminology remains aligned with project scope.

Core Features & Use Cases

  • Verify public API surfaces and documentation consistency for src/index.ts exports and related modules.
  • Check for compatibility risk, non-breaking changes, and clear changelog intent when exporting signatures or on-disk layouts are affected.
  • Validate test coverage and test quality for PRs touching src/, test/, or documentation.
  • Ensure terminology strictly distinguishes between DataSync filesystem store and other components (CDA/CMA HTTP SDK).

Quick Start

Run this checklist on a PR to surface API, compatibility, and testing gaps specific to the DataSync filesystem content store.

Frequently Asked Questions about code-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a PR that modifies the DataSync filesystem content store?▼

To review a PR for the DataSync filesystem content store, run this checklist to verify API stability, compatibility risks, and test coverage for changes in src/, test/, and public docs.

What API compatibility checks are needed for DataSync filesystem store exports?▼

API compatibility checks for DataSync filesystem store exports verify public API surfaces in src/index.ts, assess semver impact for on-disk layout changes, and ensure non-breaking changes with clear changelog intent.

Does this code review checklist validate test coverage for DataSync filesystem changes?▼

Yes, this code review checklist validates test coverage and test quality specifically for PRs touching the DataSync filesystem content store's src/, test/, or documentation files.

How do I ensure terminology alignment when reviewing DataSync filesystem store PRs?▼

Terminology alignment in DataSync filesystem store PRs ensures strict distinction between the filesystem store and other components, specifically preventing confusion with the CDA/CMA HTTP SDK.

Can I use this checklist for PRs outside the DataSync filesystem content store scope?▼

No, this checklist specifically applies to PRs touching the DataSync filesystem content store and does not cover the CDA/CMA HTTP SDK or components outside src/, test/, and public docs.

What documentation consistency is verified during a DataSync filesystem store code review?▼

Documentation consistency verification checks that public exports, on-disk layout changes, and terminology alignment are verified and logged for reviewers across src/, test/, and public docs.

Related Skills

Explore More Software Engineering Skills→
contentstackcontentstack
1

typescript

Standardize TypeScript tooling and project structure for datasync-content-store-filesystem.

Official
Intermediate
contentstackcontentstack
1

testing

Develop and maintain Jest tests for datasync-content-store-filesystem TypeScript behavior.

Official
Intermediate
MichealWayneMichealWayne
207

verify-docs-tests

Compare public API exports with documentation and test coverage across fe-tools packages.

Community
Intermediate
luongnv89luongnv89
40.9k

brand-voice-consistency

Check content against brand voice and tone guidelines.

Community
Basic