From 990b9f33b8bdf0ea9f4417544c07372ea1309a20 Mon Sep 17 00:00:00 2001 From: techfg Date: Sat, 16 Mar 2024 01:13:12 -0700 Subject: [PATCH] chore : update docs --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 10 ++++++++++ CONTRIBUTING.md | 12 ++++++------ LICENSE | 4 ++-- README.md | 3 --- SUPPORT.md | 2 +- 6 files changed, 20 insertions(+), 13 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 000a916..de9b3bb 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,7 +11,7 @@ body: 1. Have you read ImageMapster's [Code of Conduct](https://github.com/jamietre/ImageMapster/blob/main/CODE_OF_CONDUCT.md)? By filing an Issue, you are expected to comply with it, including treating everyone with respect. 1. Have you read ImageMapster's [Contributing Guidelines](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md)? If not, please review them before filing an issue. 1. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported? - 1. Do you want to ask a question? Are you looking for support? [StackOverflow with the imagemapster tag](https://stackoverflow.com/questions/tagged/imagemapster) is the best place for getting support. + 1. Do you want to ask a question? Are you looking for support? **Please do not use the issue tracker for personal support requests.** For questions, how to's, etc, please see the [Support Page](https://github.com/jamietre/ImageMapster/blob/main/SUPPORT.md) for options. - type: textarea id: description diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index a4210c3..b97aed7 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -3,6 +3,16 @@ description: Suggest an idea for this project title: '[✨] ' labels: 'new feature' body: + - type: markdown + attributes: + value: | + ## Before Submitting an Issue + + 1. Have you read ImageMapster's [Code of Conduct](https://github.com/jamietre/ImageMapster/blob/main/CODE_OF_CONDUCT.md)? By filing an Issue, you are expected to comply with it, including treating everyone with respect. + 1. Have you read ImageMapster's [Contributing Guidelines](https://github.com/jamietre/ImageMapster/blob/main/CONTRIBUTING.md)? If not, please review them before filing an issue. + 1. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported? + 1. Do you want to ask a question? Are you looking for support? **Please do not use the issue tracker for personal support requests.** For questions, how to's, etc, please see the [Support Page](https://github.com/jamietre/ImageMapster/blob/main/SUPPORT.md) for options. + - type: textarea id: description attributes: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4bb78ee..43beb58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,19 +19,19 @@ A bug is a _demonstrable problem_ that is caused by the code in the repository. Guidelines for bug reports: 1. **Lint your code** — Use [eslint](http://eslint.org/) to ensure your problem isn't caused by a simple error in your own code. -1. **Use the GitHub issue search** — check if the issue has already been reported. -1. **Check if the issue has been fixed** — try to reproduce it using the latest `main` or development branch in the repository. -1. **Isolate the problem** — ideally create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a [live example](https://jsfiddle.net). +1. **Use the GitHub issue search** — Check if the issue has already been [reported](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+). +1. **Check if the issue has been fixed** — Try to reproduce it using the latest `main` or development branch in the repository. +1. **Isolate the problem** — Create a [reduced test case](https://css-tricks.com/reduced-test-cases/) and a [live example](https://jsfiddle.net) using the latest version of ImageMapster and preferrably, the latest version of jQuery/zepto. A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report. What is your environment? What steps will reproduce the issue? What browser(s) and OS experience the problem? Do other browsers show the bug differently? What would you expect to be the outcome? All these details will help people to fix any potential bugs. -Once you have established that there is a potential issue, please use the [bug report](https://github.com/jamietre/ImageMapster/issues/new?template=bug_report.md) issue template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information for the team to evaluate/reproduce. +Once you have established that there is a potential issue, please use the [bug report](https://github.com/jamietre/ImageMapster/issues/new?template=bug_report.yml) issue template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information for the team to evaluate/reproduce. ## Feature requests -Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. +Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project and [search](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) existing issues to see if your idea has already been requested. -Please use the [feature request](https://github.com/jamietre/ImageMapster/issues/new?template=feature_request.md) issue template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information to evaluate your proposal. +Please use the [feature request](https://github.com/jamietre/ImageMapster/issues/new?template=feature_request.yml) issue template and supply all requested information. If the required information is not provided, your issue will be marked with the 'needs author feedback' label and closed until there is enough information to evaluate your proposal. ## Pull requests diff --git a/LICENSE b/LICENSE index 10862f2..0396546 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2011-2021 James Treworgy +Copyright (c) 2011-2024 James Treworgy Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. \ No newline at end of file +THE SOFTWARE. diff --git a/README.md b/README.md index 35bb8d2..af1b698 100644 --- a/README.md +++ b/README.md @@ -159,9 +159,6 @@ ImageMapster includes several examples. To view the examples: > [!NOTE]\ > By default, examples will run using jQuery. To run examples using Zepto, modify the examples HTML file per the information in [Development -> Examples](#examples-1). -```diff -``` - ## Zepto Compatibility As of ImageMapster v1.3.2, ImageMapster contains full support for Zepto v1.2.0. The latest Zepto compatible version of ImageMapster is [1.6.0](https://github.com/jamietre/ImageMapster/releases/tag/v1.6.0). diff --git a/SUPPORT.md b/SUPPORT.md index 6bbfc0f..7c76560 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -16,4 +16,4 @@ Have questions? Looking for support for ImageMapster? - You can review the [source code on GitHub](https://github.com/jamietre/ImageMapster). -If you identify a bug, please file a [bug report](https://github.com/jamietre/ImageMapster/issues/new?template=bug_report.md) and if you'd like to see a new feature, please file a [feature request](https://github.com/jamietre/ImageMapster/issues/new?template=feature_request.md)! +If you identify a bug, please file a [bug report](https://github.com/jamietre/ImageMapster/issues/new?template=bug_report.yml) and if you'd like to see a new feature, please file a [feature request](https://github.com/jamietre/ImageMapster/issues/new?template=feature_request.yml)!