Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PDE-3048 docs: CONTRIBUTING.md and release guide #506

Merged
merged 2 commits into from
Mar 3, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,5 @@ boilerplate/build
.vscode

.idea/

.DS_Store
62 changes: 62 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# Contributing

## Terms

This contributor guide is mainly for Zapier employees. However, zapier-platform is a
public repo. Everyone is welcome to submit a pull request (PR). For non-employees, you
must agree to the terms of service listed on https://zapier.com/platform/tos or the
[LICENSE][license] file of the repo before contributing.

## Local Setup

Install [Yarn][yarn] if you haven't. We use Yarn to manage packages.

Clone this repo with git:

```bash
git clone [email protected]:zapier/zapier-platform.git
cd zapier-platform
```

In the repo directory, install dependencies with yarn:

```bash
yarn
```

That's it! Now you have a local environment for development.

## Running Tests

You can run all tests for all packages with yarn test:

```bash
yarn test
```

You seldom need to run all the tests because we have [CI][ci] do it. You have several ways to
filter running tests.

### Running All Tests in a Package

To run tests for a single package, you go into the package directory and run yarn test.
For example, this is how you run all the tests for the cli package:

```bash
cd packages/cli
yarn test
```

### Using .only

TBA

## Releasing a New Version

**Zapier employees only.** Refer to this [internal doc](releasing) on how to cut a release.


[license]: https://github.com/zapier/zapier-platform/blob/master/LICENSE
[yarn]: https://yarnpkg.com
[ci]: https://github.com/zapier/zapier-platform/actions/workflows/ci.yaml
[releasing]: https://coda.io/d/Team-Developer-Platform_di0MgBhlCWf
30 changes: 10 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,13 @@ It consists of a few main packages:
- `zapier-platform-legacy-scripting-runner`: If your app started as a Legacy Web Builder app, this provides a shim that keeps your app running seamlessly
- `example-apps/*`: A varied set of example apps to get you started

## Getting Started

```bash
# Install Yarn if you haven't
brew install yarn

# Clone this repo
git clone [email protected]:zapier/zapier-platform.git
cd zapier-platform

# Install dependencies
yarn

# Run tests for all packages
yarn test

# Run tests for an individual package
cd packages/cli
yarn test
```
## Docs

* Public-facing docs:
- [Latest CLI developer guide](https://github.com/zapier/zapier-platform/blob/master/packages/cli/README.md)
- [Latest CLI command reference](https://github.com/zapier/zapier-platform/blob/master/packages/cli/docs/cli.md)
- [Latest schema docs](https://github.com/zapier/zapier-platform/blob/master/packages/schema/docs/build/schema.md)
- The :point_up: docs are also hosted at https://platform.zapier.com
* Internal-facing docs:
- Learn about how this repo is structured in [ARCHITECTURE.md](ARCHITECTURE.md).
- Looking to contribute to this repo? See [CONTRIBUTING.md](CONTRIBUTING.md).
2 changes: 1 addition & 1 deletion packages/legacy-scripting-runner/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## 3.8.6

- :nail_care: Fix issues with file uploading ([#496](https://github.com/zapier/zapier-platform/pull/496))
- :bug: Fix issues with file uploading ([#496](https://github.com/zapier/zapier-platform/pull/496))
- :nail_care: Pass `legacy.skipEncodingChars` to `z.request()` ([#501](https://github.com/zapier/zapier-platform/pull/501))

## 3.8.5
Expand Down