Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

87 lines (64 loc) · 2.09 KB

Contributing to Screenly Zapier Integration

Thank you for your interest in contributing to the Screenly Zapier Integration! This document provides guidelines and steps for contributing to this project.

Getting Started

  1. Fork the repository
  2. Clone your fork: 
    git clone https://github.com/YOUR_USERNAME/zapier
cd zapier
  3. Install dependencies: 
    npm install

Development Environment

  • Node.js (LTS version recommended)
  • npm (comes with Node.js)
  • Zapier CLI: 
    npm install -g zapier-platform-cli

Development Workflow

  1. Create a new branch for your feature/fix:

    git checkout -b feature/your-feature-name

  2. Make your changes and ensure:

    • All tests pass: npm test
    • Code is properly linted: npm run lint
    • Security audit passes: npm audit

  3. Commit your changes:

    git commit -m "feat: add new feature"

    Please follow Conventional Commits specification.

Testing

  • Write unit tests for new features
  • Ensure existing tests pass
  • Run tests: npm test

Code Style

  • Follow JavaScript Standard Style
  • Use ES6+ features
  • Keep code modular and reusable

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the documentation if needed
  3. Ensure all tests pass and coverage requirements are met
  4. Create a Pull Request with a clear title and description
  5. Link any relevant issues
  6. Link the pull request to at least one of the following labels:
    • bug
    • enhancement
    • documentation
    • chore

Working with the Screenly API

Release Process

  1. The maintainers will review your PR
  2. Once approved, it will be merged to main
  3. Releases are created following semantic versioning

Questions or Problems?

  • Open an issue in the repository
  • Tag it appropriately (bug, enhancement, question, etc.)
  • Provide as much context as possible