Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (52 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

73 lines (52 loc) · 1.61 KB

Contributing to DevMe SDK JS

Thank you for your interest in contributing to DevMe SDK JS! We welcome contributions from the community.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a new branch for your feature or fix
  4. Make your changes
  5. Push to your fork
  6. Submit a pull request to the master branch

Development Setup

# Install dependencies
npm install

# Run tests
npm test

# Run linter
npm run lint

# Run type checking
npm run typecheck

# Build the project
npm run build

Code Style

  • Follow the existing code style in the project
  • Use TypeScript for all new code
  • Ensure all tests pass before submitting
  • Run linter and fix any issues
  • Ensure type checking passes

Commit Messages

  • Use clear and descriptive commit messages
  • Follow conventional commit format when possible:
    • feat: for new features
    • fix: for bug fixes
    • docs: for documentation changes
    • refactor: for code refactoring
    • test: for test additions or changes
    • chore: for maintenance tasks

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Ensure all tests pass
  3. Update documentation as needed
  4. Request review from maintainers
  5. Address any feedback provided

Reporting Issues

  • Use GitHub Issues to report bugs
  • Provide clear reproduction steps
  • Include relevant system information
  • Attach any relevant logs or screenshots

Questions?

Feel free to open an issue for any questions about contributing.

License

By contributing, you agree that your contributions will be licensed under the same license as the project.