-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from navarasu/fix_20_issue_template
#20 Added issue template for bug and feature request.Added contributing guidelines
- Loading branch information
Showing
4 changed files
with
99 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: "" | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**Error Stack Trace** | ||
In case of any error, re run the command with debug mode `SLS_DEBUG=* sls deploy ` and share the full stack trace | ||
|
||
**Example Config files** | ||
if it is due to specific `serverless.yml` or `Gemfile`. Share the file details | ||
|
||
**Desktop (please complete the following information):** | ||
- OS: [e.g. Mac OS] | ||
- NodeVersion [e.g. 12.16.1] | ||
- Ruby version [e.g. 2.5.8] | ||
- Bundler version [e.g. 2.1.2] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
**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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Contributing | ||
|
||
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:. | ||
|
||
## How do I... <a name="toc"></a> | ||
|
||
* [Use This Guide](#introduction)? | ||
* Ask or Say Something? 🤔🐛😱 | ||
* [Request Support](#request-support) | ||
* [Report an Error or Bug](#report-an-error-or-bug) | ||
* [Request a Feature](#request-a-feature) | ||
* Make Something? 🤓👩🏽💻📜🍳 | ||
* [Project Setup](#project-setup) | ||
|
||
## Introduction | ||
|
||
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!📝 | ||
|
||
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. 💚 | ||
|
||
## Request Support or Report an Error | ||
|
||
If you have a question about this project, how to use it, or just need clarification about something: | ||
|
||
* Open an Issue at https://github.com/navarasu/serverless-ruby-layer/issues | ||
* Fill the template and you are good to go👍 | ||
|
||
Once it's filed: | ||
|
||
* The project team will [label the issue](#label-issues). | ||
* Someone will try to have a response soon. | ||
* 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. | ||
|
||
## Request a Feature | ||
|
||
If the project doesn't do something you need or want it to do: | ||
|
||
* Open an Issue at https://github.com/navarasu/serverless-ruby-layer/issues | ||
* Follow the template for Enhancements and you are good to go👍 | ||
|
||
Once it's filed: | ||
|
||
* The project team will [label the issue](#label-issues). | ||
* 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. | ||
* 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. | ||
|
||
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. | ||
|
||
## Project Setup | ||
|
||
To Be Updated soon !!! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters