Skip to content

Commit e1fc02b

Browse files
Merge pull request #52 from Wferr/v1
Create CONTRIBUTING.md
2 parents 41c3f85 + 6dae4eb commit e1fc02b

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## How to contribute to serverless-dynamodb-local
2+
3+
#### **Did you find a bug?**
4+
5+
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/99xt/serverless-dynamodb-local/issues).
6+
7+
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/99xt/serverless-dynamodb-local/issues/new). 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 behavior that is not occurring.
8+
9+
#### **Did you write a patch that fixes a bug?**
10+
11+
* Open a new GitHub pull request with the patch.
12+
13+
* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
14+
15+
#### **Do you intend to add a new feature or change an existing one?**
16+
17+
* Suggest your change in the [Gitter](https://gitter.im/99xt/serverless-dynamodb-local?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) and start writing code.
18+
19+
* Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.
20+
21+
#### **Do you have questions about the source code?**
22+
23+
* Ask any question about how to use serverless-dynamodb-local in the [Glitter](https://gitter.im/99xt/serverless-dynamodb-local?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge).
24+
25+
</br>
26+
27+
serverless-dynamodb-local is a volunteer effort. We encourage you to pitch in and [join the team](https://github.com/99xt/serverless-dynamodb-local/graphs/contributors)!
28+
29+
Thanks! :heart: :heart: :heart:
30+
31+
serverless-dynamodb-local Team
32+
33+
CONTRIBUTING file inspired/based on [rails contrubiting](https://github.com/rails/rails/blob/master/CONTRIBUTING.md)

0 commit comments

Comments
 (0)