From 634632fd8a4a2543e31279a538732f7feb1adcc3 Mon Sep 17 00:00:00 2001 From: techfg Date: Thu, 21 Mar 2024 21:54:33 -0700 Subject: [PATCH] chore: lint fixes for markdown --- .github/ISSUE_TEMPLATE/bug_report.yml | 6 +++--- .github/ISSUE_TEMPLATE/feature_request.yml | 6 +++--- .github/PULL_REQUEST_TEMPLATE.md | 8 +++++--- CHANGELOG.md | 6 +++--- CODE_OF_CONDUCT.md | 4 ++-- CONTRIBUTING.md | 8 ++++---- README.md | 8 ++++---- SUPPORT.md | 5 ----- 8 files changed, 24 insertions(+), 27 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index af02f3e..53f8e7f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -9,9 +9,9 @@ body: ## 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. + 2. 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. + 3. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported? + 4. 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 3ac8dc9..100eef9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -9,9 +9,9 @@ body: ## 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. + 2. 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. + 3. Have you searched [existing issues](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+) to see if your issue has already been reported? + 4. 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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 08ef470..d28c0aa 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,4 +1,6 @@ -# IMPORTANT: Please do not create a Pull Request without creating an issue first +# IMPORTANT + +Please do not create a Pull Request without creating an issue first. ## Before Submitting a Pull Request @@ -11,14 +13,14 @@ ## What is this change for? -- [ ] Feature / enhancement - _Any change should be discussed in the associated Issue before proceeding. Failure to do so may result in the rejection of the pull request._ +- [ ] Feature / enhancement - *Any change should be discussed in the associated Issue before proceeding. Failure to do so may result in the rejection of the pull request.* - [ ] Bug - [ ] Docs - [ ] Tests ## Description (required) -**_Please provide enough information so that others can review your pull request._** +***Please provide enough information so that others can review your pull request.*** Explain the **details** for making this change. What existing problem does the pull request solve and/or what capability does it add? Example: When "Adding a function to do X", explain why it is necessary to have a way to do X. diff --git a/CHANGELOG.md b/CHANGELOG.md index c486175..3619783 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -16,7 +16,7 @@ ## Version 1.6.0 - 2024.03.12 -- [Issue 394](https://github.com/jamietre/ImageMapster/issues/394) [TouchScreen only] Weird highlight glitch when touch on the other area beside the map. +- [Issue 394](https://github.com/jamietre/ImageMapster/issues/394) \[TouchScreen only] Weird highlight glitch when touch on the other area beside the map. ## Version 1.5.4 - 2021.02.20 @@ -71,7 +71,7 @@ - [Issue 324](https://github.com/jamietre/ImageMapster/issues/324) Improve project health - [Issue 325](https://github.com/jamietre/ImageMapster/issues/325) Add badges & CDN info to readme - [Issue 327](https://github.com/jamietre/ImageMapster/issues/327) Add linter & format files -- [Issue 328](https://github.com/jamietre/ImageMapster/issues/328) Fix tracking internal map_cache on unbind +- [Issue 328](https://github.com/jamietre/ImageMapster/issues/328) Fix tracking internal map\_cache on unbind - [Issue 330](https://github.com/jamietre/ImageMapster/issues/330) Fix shapes example rectangle responds to mouseevents - [Issue 332](https://github.com/jamietre/ImageMapster/issues/332) Fix programmatic area highlight to single area at a time - [Issue 333](https://github.com/jamietre/ImageMapster/issues/333) Fix USA example area highlight & select @@ -254,7 +254,7 @@ Notes - added tests for tooltip external & event bound invocation - added invoking tooltip from area, e.g. $('some-area').mapster('tooltip') - added invoking tooltip from key, e.g. .mapster('tooltip',key); -- Bug fix for get_options, showToolTip (related) +- Bug fix for get\_options, showToolTip (related) - Bug fix - area id 0 on VML rendereding deselection causes all selections to disappear (introduced in beta 2) - Changed "get" to return true "selected" state and not "isSelected()" which includes staticState items in selected. - Bug fix - stroke sometimes rendered improperly when using render-specific options diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 5142bf9..0c3bc59 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -70,7 +70,7 @@ members of the project's leadership. This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at . -[homepage]: https://www.contributor-covenant.org - For answers to common questions about this code of conduct, see . + +[homepage]: https://www.contributor-covenant.org diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e1e4864..54c47f4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,14 +14,14 @@ The [issue tracker](https://github.com/jamietre/ImageMapster/issues) is the pref ## Bug reports -A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful, so thank you! +A bug is a *demonstrable problem* that is caused by the code in the repository. Good bug reports are extremely helpful, so thank you! 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](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. +2. **Use the GitHub issue search** - Check if the issue has already been [reported](https://github.com/jamietre/ImageMapster/issues?q=is%3Aissue+). +3. **Check if the issue has been fixed** - Try to reproduce it using the latest `main` or development branch in the repository. +4. **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. diff --git a/README.md b/README.md index cc97517..5b9ce56 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # ImageMapster: A jQuery Plugin to make image maps useful [![license](https://img.shields.io/github/license/jamietre/ImageMapster)](LICENSE) -[![gh stable](https://img.shields.io/github/v/release/jamietre/imagemapster?sort=semver&label=stable)](https://GitHub.com/jamietre/ImageMapster/releases/) -[![gh latest](https://img.shields.io/github/v/release/jamietre/imagemapster?include_prereleases&sort=semver&label=latest)](https://GitHub.com/jamietre/ImageMapster/releases/) +[![gh stable](https://img.shields.io/github/v/release/jamietre/imagemapster?sort=semver\&label=stable)](https://GitHub.com/jamietre/ImageMapster/releases/) +[![gh latest](https://img.shields.io/github/v/release/jamietre/imagemapster?include_prereleases\&sort=semver\&label=latest)](https://GitHub.com/jamietre/ImageMapster/releases/) [![npm downloads](https://img.shields.io/npm/dm/imagemapster?label=npm)](https://www.npmjs.com/package/imagemapster) [![jsDelivr downloads](https://data.jsdelivr.com/v1/package/npm/imagemapster/badge?style=rounded)](https://www.jsdelivr.com/package/npm/imagemapster) [![cdnjs version](https://img.shields.io/cdnjs/v/imagemapster.svg?color=orange)](https://cdnjs.com/libraries/imagemapster) @@ -143,7 +143,7 @@ $('#usamap').mapster('set', true, 'new-england'); $('#usamap').mapster('set', true, 'really-cold'); ``` -Groups created this way are _independent_ of the primary group. If you select "new-england" from code, you can't unselect just "MA" by clicking on it. You would have to unselect "new-england" from code. +Groups created this way are *independent* of the primary group. If you select "new-england" from code, you can't unselect just "MA" by clicking on it. You would have to unselect "new-england" from code. To simply indentify a set of areas to turn on or off, but not treat them as a logical group, you can use CSS classes and select areas directly, or use the `keys` option to identify the primary keys associated with a group (see documentation). @@ -344,4 +344,4 @@ The source code is broken into several modules to make management easier and to ## License -Copyright © 2011-24 [James Treworgy](https://github.com/jamietre). Licensed under the [MIT License](LICENSE). +Copyright © 2011-24 [James Treworgy](https://github.com/jamietre). Licensed under the [MIT License](LICENSE). diff --git a/SUPPORT.md b/SUPPORT.md index 7c76560..0e4e20d 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -5,15 +5,10 @@ Have questions? Looking for support for ImageMapster? - There are lots of examples and documentation on the [ImageMapster web site](http://www.outsharked.com/imagemapster). - - I write about ImageMapster on my blog from time to time. See [posts about imagemapster](http://blog.outsharked.com/search/label/imagemapster). - - Take a look at [ImageMapster questions on StackOverflow](http://stackoverflow.com/search?q=imagemapster); there are quite a few. Maybe someone's asked the same question already. - - There are also some very detailed discussions in the [GitHub issues](https://github.com/jamietre/imagemapster/issues?direction=desc&labels=support&page=1&sort=created&state=closed) section that I've flagged as "support". The issues section is no longer the way to request support but these issues can provide valuable insight. - - You can also check the [feedback](http://www.outsharked.com/imagemapster/default.aspx?feedback.html) page on the project web site. - - 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.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)!