From d5cd3f84b9e8b722aafca79a7c6673f840f18676 Mon Sep 17 00:00:00 2001 From: sanjeev Date: Wed, 2 Nov 2022 13:47:07 +0530 Subject: [PATCH 1/2] Added different github templates (issue reporting, feature request, contribution etc) --- .github/CONTRIBUTING.md | 25 +++++++++++++++ .github/ISSUE_TEMPLATE/Bug_report.md | 36 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/Feature_request.md | 4 +++ .github/ISSUE_TEMPLATE/Support_question.md | 13 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 +++++++ .github/SECURITY.md | 8 +++++ 6 files changed, 97 insertions(+) create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/Bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/Feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/Support_question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/SECURITY.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 000000000..0393c3350 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -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 [community-skeleton 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 - ``` +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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md new file mode 100644 index 000000000..047267dc6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Bug_report.md @@ -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....] \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Feature_request.md b/.github/ISSUE_TEMPLATE/Feature_request.md new file mode 100644 index 000000000..3b0810325 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Feature_request.md @@ -0,0 +1,4 @@ +--- +name: "💡 Feature Request" +about: 'Share your ideas with our team or request new features' +--- \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/Support_question.md b/.github/ISSUE_TEMPLATE/Support_question.md new file mode 100644 index 000000000..0efad5b2c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Support_question.md @@ -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 support@webkul.com +- Visit official support website (https://webkul.uvdesk.com/en/) +- Visit our community forums (https://forums.qloapps.com/) + +Thanks! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..57ec1cc5b --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ + + +### 1. Why is this change necessary? + + +### 2. What does this change do, exactly? + + +### 3. Please link to the relevant issues (if any). diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 000000000..960649eaf --- /dev/null +++ b/.github/SECURITY.md @@ -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 support@webkul.com and don't disclose it publicly until we can provide a fix for it. + +Thanks! From b0cf6a8a7b5af318cee9540b36addc0c38c4f673 Mon Sep 17 00:00:00 2001 From: sanjeev Date: Thu, 3 Nov 2022 11:18:23 +0530 Subject: [PATCH 2/2] Fixed typo --- .github/CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 0393c3350..731f12e94 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -11,7 +11,7 @@ For individual issues please use the [Community Forum](https://forums.qloapps.co #### **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 [community-skeleton repository](https://github.com/webkul/hotelcommerce). +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