Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added different Github templates (issue reporting, feature request etc) #442

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## How to contribute to QloApps


### **Bug Reporting**

1. Verify that the bug was not already reported by searching on GitHub in the [Issues section](https://github.com/webkul/hotelcommerce/issues)
If you're unable to find an open issue, [open a new one](https://github.com/webkul/hotelcommerce/issues/new?assignees=&labels=&template=Bug_report.md).

2. Verify that the bug you are reporting is a general issue and not specific to your individual setup.
For individual issues please use the [Community Forum](https://forums.qloapps.com/).

#### **Did you fix a bug?**

1. To provide a code contribution for an issue you will need to set up your own fork of the [QloApps repository](https://github.com/webkul/hotelcommerce).
Make your code changes, commit the changes and make a [Pull Request](https://help.github.com/articles/about-pull-requests/) to the respective repository.
2. Separate each fix into a new branch in your repository and name it with the issue ID e.g. issue-1456.
3. When committing to your individual branch, please try and use the following as your commit message
```Fixed #1456 - <the subject of the issue>```
4. Please follow the pull request [template](https://github.com/webkul/hotelcommerce/blob/master/.github/PULL_REQUEST_TEMPLATE.md) as much as possible.

### **Did you create a new feature or enhancement?**
1. To provide a code contribution for a new feature or enhancement a [feature request](https://github.com/webkul/hotelcommerce/issues/new?assignees=&labels=&template=2_Feature_request.md) report should be created in case it doesn't exist.
2. To contribute a feature to QloApps, you must create a forked repository and set up your git and development environment.
3. Make sure your commit messages are relevant and descriptive.
4. Please follow the pull request [template](https://github.com/webkul/hotelcommerce/blob/master/.github/PULL_REQUEST_TEMPLATE.md) as much as possible.
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: "🐛 Bug Report"
about: 'Report a general library issue.'
---

# Bug report

### Title
**Just a quick sentence to brief your trouble with QloApps or something associated with it.**
**Please be calm, short and emphasize on points.**

### Issue Description
**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.**

1. framework Version.
2. Commit id.

### Steps to reproduce
**It is important to provide a set of clear steps to reproduce this bug. If relevant please include code samples.**

1. step1
2. step2

### Expected result
**Tell us what should happen.**

* [Screenshots, logs or description]

### Actual result

> **Tell us what happens instead.**

* [points....]
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: "💡 Feature Request"
about: 'Share your ideas with our team or request new features'
---
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE/Support_question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
name: ⛔ Support Question
about: Visit https://webkul.uvdesk.com/ to learn more about how the QloApps team can assist you.

---

We use GitHub issues only to discuss about QloApps bugs and new features. For customizations and extended support:

- Contact us at [email protected]
- Visit official support website (https://webkul.uvdesk.com/en/)
- Visit our community forums (https://forums.qloapps.com/)

Thanks!
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--
Thank you for contributing to QloApps! Please fill out this description template to help us to process your pull request.
-->

### 1. Why is this change necessary?


### 2. What does this change do, exactly?


### 3. Please link to the relevant issues (if any).
8 changes: 8 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Security Policy
===============

⚠ PLEASE DON'T DISCLOSE SECURITY-RELATED ISSUES PUBLICLY, SEE BELOW.

If you have found a security issue in QloApps, please send the details to [email protected] and don't disclose it publicly until we can provide a fix for it.

Thanks!