Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (52 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

75 lines (52 loc) · 1.7 KB

Contributing to AgentStack SDK

RU: CONTRIBUTING_ru.md

Thank you for your interest in contributing to AgentStack SDK!

Getting Started

Prerequisites

  • Node.js >= 20
  • npm >= 10

Setup

# Clone the repository
git clone https://github.com/agentstacktech/agentstack-sdk.git
cd agentstack-sdk

# Install dependencies (from repo root)
npm install

# Build the core package
npm run build

Running Tests

npm run test
npm run check:docs-i18n:all

Documentation (i18n)

English is canonical. Update *_ru.md in the same PR. See docs/DOCS_I18N.md. Run npm run check:docs-i18n:all before PR.

Linting

npm run lint

Development Workflow

  1. Create a branch from main: git checkout -b feature/your-feature-name
  2. Make your changes in packages/core/src/
  3. Run npm run build and npm run test
  4. Commit with Conventional Commits:
    • feat: add new method
    • fix: resolve retry logic
    • docs: update README
  5. Push and open a Pull Request

Code Style

  • Follow the project's .cursorrules for code style
  • Use TypeScript strict mode
  • Include type hints for all public APIs
  • Add docstrings for exported functions and classes

Pull Request Guidelines

  • Keep PRs focused and reasonably sized
  • Ensure all tests pass
  • Update documentation if needed
  • Reference any related issues

Questions?