Skip to content

Commit

Permalink
Merge pull request #26 from chvarkov/develop
Browse files Browse the repository at this point in the history
Added LICENSE and CONTRIBUTING.md
  • Loading branch information
chvarkov authored Jan 15, 2021
2 parents f05e091 + f81d416 commit 5c26aa0
Show file tree
Hide file tree
Showing 6 changed files with 125 additions and 3 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: chvarkov

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Describe steps to reproduce the behavior. Code examples.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature request
assignees: chvarkov

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
58 changes: 58 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributing

Thanks for considering contributing to GoogleRecaptchaModule!

## Opening issues

If you find a bug, please feel free to [open an issue](https://github.com/chvarkov/google-recaptcha/issues).

If you taking the time to mention a problem, even a seemingly minor one, it is greatly appreciated, and a totally valid contribution to this project. Thank you!

## Fixing bugs

We love pull requests. Here’s a quick guide:

1. [Fork this repository](https://github.com/chvarkov/google-recaptcha/fork) and then clone it locally:

```bash
git clone https://github.com/chvarkov/google-recaptcha.git
```

2. Create a topic branch for your changes:

```bash
git checkout -b bugfix/for-that-thing
```
3. Commit a failing test for the bug:

```bash
git commit -am "Adds a failing test to demonstrate that thing"
```

4. Commit a fix that makes the test pass:

```bash
git commit -am "Adds a fix for that thing!"
```

5. Run the tests:

```bash
npm test
```

6. If everything looks good, push to your fork:

```bash
git push origin fix-for-that-thing
```

7. [Submit a pull request.](https://help.github.com/articles/creating-a-pull-request)

8. Enjoy being the wonderful person you are

After you’ve opened your pull request, [you should email me](mailto:[email protected]) your mailing address so I can mail you a personal thank you note. Seriously!

## Adding new features

Thinking of adding a new feature? Cool! [Open an issue](https://github.com/chvarkov/google-recaptcha/issues) and let’s design it together.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2021 Alexey Chvarkov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export class FeedbackController {

```

### Error handling
## Error handling

Google recaptcha guard will throw GoogleRecaptchaException on error.

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@nestlab/google-recaptcha",
"version": "1.2.0",
"version": "1.2.1",
"description": "Google recaptcha module for NestJS.",
"keywords": [
"nest",
Expand All @@ -17,7 +17,7 @@
"private": false,
"main": "index.js",
"scripts": {
"build": "rimraf dist && tsc && cp package.json dist && cp README.md dist",
"build": "rimraf dist && tsc && cp package.json dist && cp README.md dist && cp LICENSE dist && cp CONTRIBUTING.md dist",
"test": "jest"
},
"repository": {
Expand Down

0 comments on commit 5c26aa0

Please sign in to comment.