Skip to content

Latest commit

 

History

History
223 lines (157 loc) · 7.23 KB

CONTRIBUTING.md

File metadata and controls

223 lines (157 loc) · 7.23 KB
Raw

Contributing

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to Zapier Innovint Connector. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

This project and everyone participating in it are governed by the Code of Conduct. By participating, you are expected to uphold this code.

How can I contribute?

Star this repo

It's quick and goes a long way! 🌠

Reporting Bugs

This section guides you through submitting a bug report for Innovint Zapier Integration. Following these guidelines helps maintainers, and the community understand your report 📝, reproduce the behavior 💻, and find related reports 🔎.

When you are creating a bug report, please include as many details as possible.

How Do I Submit a Bug Report?

Bugs are tracked as GitHub issues.

Explain the problem and include additional details to help reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. Don't just say what you did, but explain how you did it.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.

Include details about your environment.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Innovint Zapier Integration. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

When you are creating an enhancement suggestion, please include as many details as possible.

How Do I Submit an Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

Create an issue on that repository and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to most Zapier Integration users.

Your First Code Contribution

Unsure where to begin contributing to Innovint Zapier Integration? You can start by looking through these good-first-issue and help-wanted issues:

  • Good first issue - issues which should only require a small amount of code, and a test or two.
  • Help wanted - issues which should be a bit more involved than Good first issue issues.

Pull Request Checklist

Before sending your pull requests, make sure you followed the list below:

  • Read these guidelines.
  • Read Code of Conduct.
  • Ensure that your code adheres to standard conventions, as used in the rest of the project.
  • Ensure that there are unit tests for your code.
  • Run unit tests.

Running tests

Integrators will first need an InnoVint user account to access the APIs. To have an account created, reach out to the support team at support@innovint.us .

Once the account is created, integrators should request winery administrators to grant the user account access to the necessary wineries. All wineries have a unique ID that should be used in API calls. Some accounts may have multiple wineries, so integrators will need access to all the wineries. Once access is granted, the IDs of all accessible wineries can be retrieved using the List Wineries API. To run tests you need an account in Innovint

  1. Generate a new Personal Access Token in your Account Settings

  2. Create a new Innovint project or just use an existing one

  3. Setup environment variables:

    cp .env.example .env

    Fill in the .env variables with your credentials.

  4. Run tests:

    npm run test

NPM Scripts Documentation

This document provides details about the npm scripts available in this project and their intended usage.

Script Descriptions

  • preversion:
    • Description: Runs before a new version is created. Pulls the latest changes from the repository and runs validation checks.
    • Usage:
npm run preversion
  • postversion:
    • Description: Runs after a new version is created. Pushes the changes and tags to the repository.
    • Usage:
npm run postversion`
  • test:
    • Description: Runs unit tests using Mocha for all files in the test/unit directory.
    • Usage:
npm test
  • test:integration:
    • Description: Runs integration tests using Mocha for all files in the test/integration directory.
    • Usage:
npm run test:integration
  • test:all:
    • Description: Runs both unit and integration tests.
    • Usage:
npm run test:all
  • deploy:
    • Description: Validates the project and deploys it using Zapier CLI.
    • Usage:
npm run deploy
  • precommit:
    • Description: Runs linting on staged files. Typically used as a pre-commit hook.
    • Usage:
npm run precommit
  • validate:
    • Description: Runs tests, lints the code, and validates the Zapier integration.
    • Usage:
npm run validate
  • lint:
    • Description: Lints the codebase using ESLint.
    • Usage:
npm run lint
  • lint:fix:
    • Description: Automatically fixes linting errors in the codebase.
    • Usage:
npm run lint:fix

  • env:

    • Description: Sets an environment variable for the Zapier integration.
    • Usage: npm run env --var=VARIABLE_NAME --val=VALUE
    • Example: npm run env --var=API_KEY --val=12345

  • prepare:

    • Description: Sets up Husky, which is used for managing Git hooks.
    • Usage:
npm run prepare

Notes for Developers

  • Validation: Ensure to run npm run validate before committing to check for any issues.
  • Linting: Use npm run lint:fix to automatically fix common code style issues.
  • Testing: When adding new features or fixing bugs, write tests in the appropriate test/unit or test/integration directories and ensure they pass by running npm run test:all.
  • Deployment: Before deploying a new version, it's a good practice to run npm run deploy to make sure everything is in order.

Philosophy of code contribution

  • Include unit tests when you contribute new features, as they help to a) prove that your code works correctly, and b) guard against future breaking changes to lower the maintenance cost.
  • Bug fixes also generally require unit tests, because the presence of bugs usually indicates insufficient test coverage.