github template added for support, bugs/issues, feature and security vulnerabilities.

This commit is contained in:
Prashant Singh 2019-09-13 00:37:58 +05:30
parent b089149268
commit 6dfa36871e
7 changed files with 46 additions and 118 deletions

View File

@ -1,12 +1,17 @@
---
name: "🐛 Bug Report"
about: 'Report a general library issue.'
---
# Bug report
### Title
**Title is a vital part of bug report for developer and triager to quickly identify a unique issue.**
**Just a quick sentence to brief your trouble with Bagisto or something associated with it.**
A well written title should contain a clear, brief explanation of the issue, making emphasis on the most important points.
Please be calm, short and emaphasize on points.
### Issue Description
**Bug description helps the developer to understand the bug.It describes the problem encountered.**
**Description helps the developers to understand the bug. It describes the problem encountered or some after effect of some kind.**
### Preconditions
**Please provide as detailed information about your environment as possible.**

12
.github/2_Feature_request.md vendored Normal file
View File

@ -0,0 +1,12 @@
---
name: "💡 Feature Request"
about: 'For ideas or feature requests, please make a pull request, or open an issue'
---
This repository is only for reporting bugs or issues. If you need support, please use the forums:
- https://forums.bagisto.com/
Alternatively, you may use Facebook (https://www.facebook.com/groups/bagisto/).
We promise that more channels are coming soon!!!

13
.github/3_Support_question.md vendored Normal file
View File

@ -0,0 +1,13 @@
---
name: "🧐 Support Question"
about: 'This repository is only for reporting bugs or problems. If you need help, see:
https://github.com/bagisto/bagisto#documentation'
---
This repository is only for reporting bugs or issues. If you need support, please use:
1. Write an email - mailto:support@bagisto.com
2. Create support ticket on https://bagisto.uvdesk.com
Thanks!

9
.github/4_Security_vulnerabilities.md vendored Normal file
View File

@ -0,0 +1,9 @@
---
name: "🔒 Security Vulnerabilities"
about: 'For reporting security-related issues, see: https://github.com/bagito/bagisto#security-vulnerabilities'
---
PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW.
If you have security vulnerability to address related to Bagisto then please write a mail to us:
**support@bagisto.com**

View File

@ -1,66 +0,0 @@
<html>
<head>
<title>Feature</title>
<style>
.bagisto
{
color: blue;
}
</style>
</head>
<body>
<div>
<h3>Title</h3>
<hr>
<p class="bagisto">
A well written title should contain a clear, brief explanation of the Feature, making emphasis on the most important points.
</p>
</div>
<div>
<h3>Preconditions</h3>
<hr>
<p class="bagisto">Please provide as detailed information about your environment as possible.</p>
<ul>
<li> framework Version:</li>
<li>Commit id:</li>
</ul>
</div>
<div>
<h3>Description</h3>
<hr>
<p class="bagisto">Description helps the developer to understand the Feature.
</p>
</div>
<div>
<h3>Steps to reproduce</h3>
<hr>
<p class="bagisto">It is important to provide a set of clear steps to that location where feature need to be added. If relevant please include code samples.</p>
<ol>
<li> step1</li>
<li> step2</li>
</ol>
</div>

View File

@ -16,7 +16,8 @@
3. [Requirements](#requirements)
4. [Installation & Configuration](#installation-and-configuration)
5. [License](#license)
6. [Miscellaneous](#miscellaneous)
6. [Security Vulnerabilities](#security-vulnerabilities)
7. [Miscellaneous](#miscellaneous)
### Introduction
@ -176,6 +177,8 @@ password:admin123
### License
Bagisto is a truly opensource E-Commerce framework which will always be free under the [MIT License](https://github.com/bagisto/bagisto/blob/master/LICENSE).
### Security Vulnerabilities
Please don't disclose security vulnerabilities publicly. If you find any security vulnerability in Bagisto then please write us mail: mailto:support@bagisto.com.
### Miscellaneous

View File

@ -1,48 +0,0 @@
<html>
<head>
<title>Support</title>
<style>
.bagisto
{
color: blue;
}
</style>
</head>
<body>
<div>
<h3>Title</h3>
<hr>
<p class="bagisto">
Title is a vital part of bug report for developer and triager to quickly identify a unique issue.
<br>
A well written title should contain a clear, brief explanation of the issue, making emphasis on the most important points.
</p>
</div>
<div>
<h3>Preconditions</h3>
<hr>
<p class="bagisto">Please provide as detailed information about your environment as possible.</p>
<ul>
<li> framework Version:</li>
<li>Commit id:</li>
</ul>
</div>
<div>
<h3>Description</h3>
<hr>
<p class="bagisto">Description helps the developer to understand the exact scenario.It describes the problem encountered.</p>
</div>
<div>
<h3>Steps to reproduce</h3>
<hr>
<p class="bagisto">It is important to provide a set of clear steps to reproduce that scenario. If relevant please include code samples.</p>
<ol>
<li> step1</li>
<li> step2</li>
</ol>
</div>