Skip to content

Latest commit

 

History

History
74 lines (57 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

74 lines (57 loc) · 3.17 KB
Raw

Contributing to function-stencil

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Contributing a new Lambda function runtime

  1. Create a new directory for your function code in the /functions directory. Name it after the runtime your are contributing eg:
/ functions
 ┗  nodejs16.x
   ┗ function
     ┣ events
     ┃ ┗ event.json
     ┣ app.js
     ┣ env.json
     ┣ harness.js
     ┗ package.json
  1. Add the new runtime to the array in template.json

Contributing a new IaC template snippet

  1. Create a new template file in the corresponding runtime directory within the /templates directory, e.g. to create a SAM template for the nodejs16.x runtime:
/templates 
┗  nodejs16.x
 ┗ sam
   ┗ template.yaml
  1. within the template file, note that the text "projectName" and "runtimeName" is replaced with the user's chosen function name and runtime respectively.

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a bug report I wrote, and I think it's not a bad model. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base R setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

License

By contributing, you agree that your contributions will be licensed under its MIT License.