Skip to content

Commit

Permalink
Adding initial documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tech-consortium committed Nov 13, 2023
1 parent 13b8a56 commit 867d52f
Show file tree
Hide file tree
Showing 3 changed files with 264 additions and 2 deletions.
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
94 changes: 94 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
# Contributing

:tada: First off, thanks for taking the time to contribute! :tada:

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](/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

## How can I contribute?

### Star this repo

It's quick and goes a long way! :stars:

### 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 :pencil:, reproduce the behavior :computer:, and find related reports :mag_right:.

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](https://github.com/danshome/zapier-integration/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 :pencil: and find related suggestions :mag_right:.

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](https://github.com/danshome/zapier-integration/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](https://github.com/danshome/zapier-integration/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) - issues which should only require a small amount of code, and a test or two.
* [Help wanted](https://github.com/danshomet/zapier-integration/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) - 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](/CODE_OF_CONDUCT.md).
- 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 [email protected] .

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 of 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](https://sutter.innovint.us/api/v1/docs/)

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:

```console
cp .env.example .env
```

Fill in the `.env` variables with your credentials.

4. Run tests:

```console
npm run test
```

#### 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.
96 changes: 94 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,94 @@
# ZapierInnovintConnector
A Zapier Connector for Innovint API
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://www.innovint.us/wp-content/uploads/2021/02/cropped-innovint-icon-150x150.png">
<source media="(prefers-color-scheme: light)" srcset="https://www.innovint.us/wp-content/uploads/2021/02/cropped-innovint-icon-150x150.png">
<img width="150" height="150" width=""src="[https://www.innovint.us/wp-content/uploads/2021/02/cropped-innovint-icon-150x150.png](https://innovint.us)">
</picture>
</p>

# Innovint Zapier Integration

Connect Innovint to hundreds of other apps with Zapier

Zapier lets you connect Innovint to 4,000+ other web services. Automated connections called Zaps, set up in minutes with no coding, can automate your day-to-day tasks and build workflows between apps that otherwise wouldn't be possible.
Each Zap has one app as the Trigger, where your information comes from and which causes one or more Actions in other apps, where your data gets sent automatically.

<div align="center">

[**`Home`**](https://zapier.com/apps/Innovint/integrations) &nbsp;|&nbsp;
[**`Docs`**](https://support.innovint.us/zapier) &nbsp;|&nbsp;
[**`Innovint Support`**](https://support.innovint.us/)

</div>

<div align="center">

<a href="https://zapier.com/apps/Innovint/integrations"><img src="https://img.shields.io/badge/dynamic/json?label=Zapier&amp;query=%24.version&amp;url=https%3A%2F%2Fraw.githubusercontent.com%2Fdanshome%2Fzapier-integration%2Fmain%2Fpackage.json&amp;logo=zapier" alt="Zapier"></a>
<a href="https://github.com/Innovint/zapier-integration/actions/workflows/tests.yml"><img src="https://github.com/danshome/zapier-integration/actions/workflows/tests.yml/badge.svg" alt="Tests"></a>
<a href="https://github.com/Innovint/zapier-integration/graphs/contributors"><img src="https://img.shields.io/github/contributors/danshome/zapier-integration?cacheSeconds=10001" alt="GitHub contributors"></a>
<a href="https://github.com/Innovint/zapier-integration/blob/master/LICENSE"><img src="https://img.shields.io/github/license/Innovint/zapier-integration?cacheSeconds=3600" alt="License"></a>

</div>

## Getting started

### Integration

This integration contains the following triggers, actions, and searches:

- **Triggers**
- List Wineries (dropdown)
- WIP
- **Actions**
- WIP
- **Searches**
- WIP

### Getting Started with Zapier

Sign up for a free [Zapier](https://zapier.com/apps/Innovint/integrations) account, from there you can jump right in. To help you hit the ground running, here are some popular pre-made Zaps.

### How do I connect Innovint to Zapier?

- Log in to your [Zapier account](https://zapier.com/sign-up) or create a new account. Navigate to "My Apps" from the top menu bar.
- Now click on "Connect a new account..." and search for "Innovint"
- Use your credentials to connect your Innovint account to Zapier.
- Once that's done you can start creating an automation!
- Use a pre-made Zap or create your own with the Zap Editor. Creating a Zap requires no coding knowledge and you'll be walked step-by-step through the setup.
- Need inspiration? See everything that's possible with [Innovint and Zapier](https://zapier.com/apps/Innovint/integrations).

## Seeking Assistance

If you find any problems or would like to suggest a feature, please read the [How can I contribute](/CONTRIBUTING.md#how-can-i-contribute) section in our contributing guidelines.

Need help working with Innovint Zapier Integration or have any questions? [Contact](https://Innovint.com/contacts) Customer Success Service.

## Contributing

If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

It's very easy to get started with these 3 steps:
- Clone this project to your local machine.
- Open terminal and cd into the cloned folder, usually `cd zapier-integration`.
- Run `npm install` to install dependencies.
- `cp .env.example .env` and put your Innovint OAuth credentials and Personal API Token for tests.
- run `zapier test` to run local tests and see if you are ready to proceed with development.
- run `zapier push` to push your local changes to your own Zapier account.
- make sure to increase `package.json` version when delivering your improvements.

You might want to check a `z` object to see it's methods. `z.console.log` stands for `console.log` for example.

Note that you will need additional a `zapier` CLI installed.


## License

<pre>
The Innovint Zapier Integration is licensed under the MIT License.
See the LICENSE file distributed with this work for additional
information regarding copyright ownership.

Except as contained in the LICENSE file, the name(s) of the above copyright
holders shall not be used in advertising or otherwise to promote the sale,
use or other dealings in this Software without prior written authorization.
</pre>

0 comments on commit 867d52f

Please sign in to comment.