When contributing to this repository, please first discuss the change you wish to make via issue, email, slack, or any other method with the contributes of this repository, or Code for Baltimore, before making a change.
Please note we have a CODE OF CONDUCT, please follow it in all your interactions with the project.
This project aims to offer simple utilities for API development on AWS Lambda. Some of these utilities may work for other frameworks like Express, however this is just a happy coincidence.
This product does not aim to offer everything needed for RESTful development on AWS Lambda, just a jump-start. We are getting the low hanging fruit to speed up development, nothing more.
This is an npm package so it's Typescript/Javascript.
Please see Best Practices for Typescript coding standards.
- Ensure you thoroughly fill out the pull request form presented when submitting the request. This includes listing what work was done, what issues are resolved by that work, what tests have been added, how to perform other tests or run the code, and other potentially relevant notes.
- Update the README.md with details of changes to the application, this includes new environment variables, exposed ports, useful file locations and/or container parameters.
- If you are on the project team you may merge the Pull Request in once you have the sign-off of one other developer, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
The best ways to get in touch with us is via Slack. An active Slack link can be found on our website:
You can also reach out to the tech lead Jason Anton via email at jason@codeforbaltimore.org.