Skip to content

Commit 4d9751c

Browse files
committed
Simplified contribution process for ironcli, added section on contributing to just lambda.
1 parent 4aab53e commit 4d9751c

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -76,12 +76,17 @@ ironcli is built from source. To make sure you can hack on the `lambda` package
7676
within the vendoring workflow, you should do something like this.
7777

7878
* Clone ironcli.
79-
* Fork this repository.
80-
* Edit the glide.yaml file to change the `lambda` package import path from
81-
`github.com/iron-io/lambda/lambda` to `github.com/<username>/lambda/lambda`.
82-
You'll also need to fix the imports in the ironcli lambda.go file.
83-
* Run `glide i` to get the new package.
84-
* Now `ironcli/vendor/github.com/<username>/lambda` will have your fork. Hack
85-
in here and submit a PR.
86-
* If you have a better idea of a workflow, we would appreciate leaving us
87-
a note.
79+
* Run `glide i` to install dependencies.
80+
* Now `ironcli/vendor/github.com/iron-io/lambda` will have a clone of the
81+
master branch of lambda.
82+
* Create a new branch, hack hack hack.
83+
* Make sure relevant code compiles and ironcli builds.
84+
* Fork the lambda repository on Github.
85+
* Add your fork as a remote: `git remote add <username> git@github.com:<username>/lambda`
86+
* Push your branch to your fork: `git push <username> <feature-branch>`
87+
* Submit a PR.
88+
89+
### Improving Lambda Docker images
90+
91+
Simply clone this repository, make changes to the Dockerfile for individual
92+
images in the `images/<runtime>` directories and submit a Pull Request.

0 commit comments

Comments
 (0)