Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (31 loc) · 1.06 KB

CONTRIBUTING.md

File metadata and controls

45 lines (31 loc) · 1.06 KB

Contributing to Salesforce Marketing Cloud SDK

Thank you for your interest in contributing to this project!

Development Setup

  1. Fork and clone the repository
  2. Install dependencies: npm install
  3. Make your changes
  4. Run tests: npm test
  5. Build: npm run build
  6. Submit a pull request

Guidelines

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style
  • Run npm run format before committing
  • Run npm run lint to check for issues

Testing

  • Write tests for all new features
  • Ensure all tests pass before submitting PR
  • Maintain or improve code coverage
  • Tests should be in the same directory as source files with .test.ts extension

Commit Messages

  • Use clear, descriptive commit messages
  • Follow conventional commits format when possible
  • Reference issue numbers in commits

Pull Requests

  • Keep PRs focused on a single feature or fix
  • Update documentation as needed
  • Add tests for new functionality
  • Ensure CI passes before requesting review

Questions?

Open an issue for any questions or concerns.