Skip to content

Commit 23efbc3

Browse files
authored
Merge pull request #25 from navarasu/fix_20_issue_template
#20 Added issue template for bug and feature request.Added contributing guidelines
2 parents 86322ed + f92529c commit 23efbc3

File tree

4 files changed

+99
-0
lines changed

4 files changed

+99
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
**Error Stack Trace**
14+
In case of any error, re run the command with debug mode `SLS_DEBUG=* sls deploy ` and share the full stack trace
15+
16+
**Example Config files**
17+
if it is due to specific `serverless.yml` or `Gemfile`. Share the file details
18+
19+
**Desktop (please complete the following information):**
20+
- OS: [e.g. Mac OS]
21+
- NodeVersion [e.g. 12.16.1]
22+
- Ruby version [e.g. 2.5.8]
23+
- Bundler version [e.g. 2.1.2]
24+
25+
**Additional context**
26+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
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. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

CONTRIBUTING.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Contributing
2+
3+
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:.
4+
5+
## How do I... <a name="toc"></a>
6+
7+
* [Use This Guide](#introduction)?
8+
* Ask or Say Something? 🤔🐛😱
9+
* [Request Support](#request-support)
10+
* [Report an Error or Bug](#report-an-error-or-bug)
11+
* [Request a Feature](#request-a-feature)
12+
* Make Something? 🤓👩🏽‍💻📜🍳
13+
* [Project Setup](#project-setup)
14+
15+
## Introduction
16+
17+
All types of contributions are encouraged and valued. See the [table of contents](#toc) for different ways to help and details about how this project handles them!📝
18+
19+
Please make sure to read the relevant section before making your contribution! It will make it a lot easier for us maintainers to make the most of it and smooth out the experience for all involved. 💚
20+
21+
## Request Support or Report an Error
22+
23+
If you have a question about this project, how to use it, or just need clarification about something:
24+
25+
* Open an Issue at https://github.com/navarasu/serverless-ruby-layer/issues
26+
* Fill the template and you are good to go👍
27+
28+
Once it's filed:
29+
30+
* The project team will [label the issue](#label-issues).
31+
* Someone will try to have a response soon.
32+
* If you or the maintainers don't respond to an issue for 30 days, the [issue will be closed](#clean-up-issues-and-prs). If you want to come back to it, reply (once, please), and we'll reopen the existing issue. Please avoid filing new issues as extensions of one you already made.
33+
34+
## Request a Feature
35+
36+
If the project doesn't do something you need or want it to do:
37+
38+
* Open an Issue at https://github.com/navarasu/serverless-ruby-layer/issues
39+
* Follow the template for Enhancements and you are good to go👍
40+
41+
Once it's filed:
42+
43+
* The project team will [label the issue](#label-issues).
44+
* The project team will evaluate the feature request, possibly asking you more questions to understand its purpose and any relevant requirements. If the issue is closed, the team will convey their reasoning and suggest an alternative path forward.
45+
* If the feature request is accepted, it will be marked for implementation with `feature-accepted`, which can then be done by either by a core team member or by anyone in the community who wants to contribute code.
46+
47+
Note: The team is unlikely to be able to accept every single feature request that is filed. Please understand if they need to say no.
48+
49+
## Project Setup
50+
51+
To Be Updated soon !!!

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ Pull requests are welcome. For major changes, please open an issue first to disc
8989

9090
Please make sure to update the tests as appropriate.
9191

92+
Refer [Guidelines](https://github.com/navarasu/serverless-ruby-layer/blob/master/CONTRIBUTING.md) for more information.
93+
9294
## License
9395

9496
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)