Skip to content

Commit 5381e04

Browse files
author
Anuraag Agrawal
committed
Add GitHub tooling
1 parent 3eebf06 commit 5381e04

File tree

5 files changed

+101
-0
lines changed

5 files changed

+101
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: Bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Steps to reproduce**
14+
If possible, provide a recipe for reproducing the error.
15+
16+
**What did you expect to see?**
17+
A clear and concise description of what you expected to see.
18+
19+
**What did you see instead?**
20+
A clear and concise description of what you saw instead.
21+
22+
**Additional context**
23+
Add any other context about the problem here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: Feature Request
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is.
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.

CODE_OF_CONDUCT.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
## Code of Conduct
2+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4+
[email protected] with any additional questions or comments.

CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines
2+
3+
Thanks a lot for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4+
documentation, we really appreciate your help. Take a look through this document to make sure we can give you a great
5+
experience with your contribution.
6+
7+
8+
## Reporting Bugs/Feature Requests
9+
10+
We're always happy to hear about any bugs or features requests using GitHub issues.
11+
12+
When filing an issue, please try to include as much information as you can. Details like these are incredibly useful:
13+
14+
* A reproducible test case or series of steps
15+
* The version of our code being used
16+
* Any modifications you've made relevant to the bug
17+
* Anything unusual about your environment or deployment
18+
19+
20+
## Contributing via Pull Requests
21+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
22+
23+
1. You are working against the latest source on the *main* branch.
24+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
25+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
26+
27+
To send us a pull request, please:
28+
29+
1. Fork the repository.
30+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
31+
3. Ensure local tests pass.
32+
4. Commit to your fork using clear commit messages.
33+
5. Send us a pull request, answering any default questions in the pull request interface.
34+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
35+
36+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
37+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
38+
39+
40+
## Finding contributions to work on
41+
Looking at the existing issues is a great way to find something to contribute on. As this is a repository for experimenting
42+
and trying out new integrations, there may be few open issues filed but we're always happy to add more test apps for
43+
different frameworks.
44+
45+
46+
## Code of Conduct
47+
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
48+
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
49+
[email protected] with any additional questions or comments.
50+
51+
52+
## Security issue notifications
53+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
54+
55+
56+
## Licensing
57+
58+
See the [LICENSE](LICENSE) file for our project's licensing. When contributing code, make sure there are no copyright
59+
headers - the code is available for users to copy into their own apps.

NOTICE

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.

0 commit comments

Comments
 (0)