Skip to content

Commit

Permalink
break out contribution information into Contributing.md (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
gcooney committed Aug 7, 2019
1 parent efbfa62 commit d8e831d
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 30 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
@@ -0,0 +1,27 @@
If you would like to contribute, please submit a PR. If you encounter an
problem, please file an Issue in this repo.

### Making updates

Actions need the compiled code checked in. This means your changes will only
take effect if you run the build to generate .js files from the .ts Typescript
files and check the .js files in as well.

### Adding new dependencies

Check in the Action with everything it needs to run. If you update dependencies
you will need to commit the changes to Node modules as well.

```bash
# Remove any non-production dependencies
npm prune --production

# Compile Typescript to ES6
npm run build

# Add the compiled Typescript output
git add lib/

# Add Node dependencies
git add -f node_modules/*
```
30 changes: 0 additions & 30 deletions README.md
Expand Up @@ -73,33 +73,3 @@ jobs:
deployment. A mabl journey is an end to end test of your application.
- `journeys_failed` {int32} - number of mabl journeys that failed against this
deployment. A mabl journey is an end to end test of your application.

## Contributions and Issues

If you would like to contribute, please submit a PR. If you encounter an
problem, please file an Issue in this repo.

### Making updates

Actions need the compiled code checked in. This means your changes will only
take effect if you run the build to generate .js files from the .ts
Typescript files and check the .js files in as well.

### Adding new dependencies

Check in the Action with everything it needs to run. If you update dependencies
you will need to commit the changes to Node modules as well.

```bash
# Remove any non-production dependencies
npm prune --production

# Compile Typescript to ES6
npm run build

# Add the compiled Typescript output
git add lib/

# Add Node dependencies
git add -f node_modules/*
```

0 comments on commit d8e831d

Please sign in to comment.