Skip to content

Commit

Permalink
Chore: dev, contributions, etc.
Browse files Browse the repository at this point in the history
  • Loading branch information
till committed Sep 6, 2022
1 parent 0092aa6 commit e6fbf6c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 6 deletions.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing

All contributions are welcome. Features, docs, bugs, ....

We currently lack a proper COC, so the least we ask is: we all respect one another.

Questions, comments, etc. — we are happy to help. :-)

## Development

For features, bugfixes, docs etc. make a branch and open a pull-request.

For local testing of your changes:

- run `make setup` to configure the default builder and trust it.
- run `make test` to build an (app) image from `./samples/deno` with one entrypoints:
- test it: `docker run --rm -p 8080:8080 test-deno-app`

## Release

Make a release branch to adjust the version in `buildpack.toml` and tag it:

```sh
git checkout -b release-x.y.z
vi buildpack.toml # to adjust the version
git commit -a -m 'Chore: update version'
git push origin release-x.y.z
git tag -a vX.Y.Z
git push --tags
```

8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,6 @@ Contains a version such as `vA.B.C`.

> (last) The buildpack also supports a `.dvmrc` file.
## Development
## Contributions?

Run `make setup` to configure the default builder and trust it.

Run `make test` to build an (app) image from `./samples/deno` with one entrypoints:

- web: `docker run --rm -p 8080:8080 test-deno-app`
See [CONTRIBUTING.md](CONTRIBUTING.md) for everything (local setup, testing, releasing).

0 comments on commit e6fbf6c

Please sign in to comment.