Skip to content

Commit

Permalink
Added contributing guidelines, added badge
Browse files Browse the repository at this point in the history
  • Loading branch information
Slaven Ivanov authored and Slaven Ivanov committed Aug 15, 2022
1 parent 8e13ff1 commit 2540997
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 4 deletions.
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to AWS Lambda Handyman

Thanks for your interest in AWS Lambda Handyman, and your contribution.

The following is a set of guidelines for contributing to AWS Lambda Handyman project, which are hosted in
the [GitHub](https://github.com/growx-tech/aws-lambda-handyman). These are mostly guidelines, not rules. Use your best
judgment, and feel free to propose changes to this document in a pull request.

## Did you find a bug?

Do not open up a GitHub issue if the bug is a security vulnerability in libraries used in this project.

### Ensure the bug was not already reported by searching on GitHub under Issues.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear
description, as much relevant information as possible, and a code sample or an executable test case demonstrating the
expected behaviour that is not occurring.

## Did you write a patch that fixes a bug?

Open a new GitHub pull request with the patch.

Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

## Did you fix white space, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability
will generally not be accepted.

## Do you want to contribute to the documentation?

Go Ahead

##

**AWS Lambda Handyman** is a volunteer effort. We encourage you to pitch in and join the team!

Thanks!
**AWS Lambda Handyman Team**
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ class SpamBot {
export const handler = SpamBot.handle
```

[![Test, Build and Deploy](https://github.com/growx-tech/aws-lambda-handyman/actions/workflows/npm-publish.yml/badge.svg?branch=master)](https://github.com/growx-tech/aws-lambda-handyman/actions/workflows/npm-publish.yml)

## Table of Contents

- [Installation](#installation)
Expand Down Expand Up @@ -247,9 +249,7 @@ class IsBalloonInflated {
- [ ] Prettier
- [ ] Documentation
- [ ] possibly cull undefined properties in validated objects
- [ ] rollup build to minify package
- [ ] non promise response functions
- [ ] add Growy logo
- [ ] setup branch protection
- [ ] add keywords to package.json
- [ ] possibly setup husky to enforce version ++
- [ ] add coverage badge
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "aws-lambda-handyman",
"version": "0.1.0",
"version": "0.1.1",
"description": "AWS Lambda validation made easy \uD83C\uDFC4",
"main": "./lib/src/index.js",
"typings": "./lib/src/index.d.ts",
Expand Down

0 comments on commit 2540997

Please sign in to comment.