Skip to content

docs: add docs for local admin dev #316

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 1, 2021
Merged

docs: add docs for local admin dev #316

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ information on using pull requests.

## Testing

### Unit Tests

All pull requests should have an associated test to ensure foward compatibility.

To run an individual test, you can run a command such as the following:
Expand All @@ -32,6 +34,23 @@ To run an individual test, you can run a command such as the following:
npm run test -- -g 'loading function'
```

### Manual Testing

When developing a feature locally, you can install a local version of the Functions Framework
using `npm link`. First compile your local clone of the Functions Framework:

```
npm compile
```

Then link the Functions Framework using `npm link`.

```
npm link
```

You can then run the Functions Framework locally using `functions-framework`.

## Community Guidelines

This project follows [Google's Open Source Community
Expand Down