42 lines (30 loc) · 911 Bytes

Contributing

Thanks for contributing to csfloat-node-sdk.

Principles

keep the repository honest about coverage and validation status
prefer official docs and live-validated behavior over assumptions
do not merge undocumented claims as if they were confirmed API surface

Development

npm install
npm test
npm run check
npm run check:node
npm run build

Before cutting a release or publishing, run:

npm run release:check

Contribution Guidelines

keep changes focused
update docs when API behavior changes
clearly mark undocumented but source-discovered behavior
do not hardcode secrets in code, tests, or examples
keep mutation examples opt-in and clearly labeled

Pull Requests

Good pull requests should include:

a clear summary of what changed
validation notes
docs updates when the public surface changed
tests when practical