From 808c48386445fdcd4260707be306eb4adf59fdbe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20=C5=BDdila?= Date: Wed, 24 May 2023 10:53:16 +0200 Subject: [PATCH] md cleanup --- CODE_OF_CONDUCT.md | 20 ++++++++++---------- CONTRIBUTING => CONTRIBUTING.md | 7 +++---- SECURITY.md | 1 - 3 files changed, 13 insertions(+), 15 deletions(-) rename CONTRIBUTING => CONTRIBUTING.md (97%) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b0bf60b..5431cca 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -8,19 +8,19 @@ In the interest of fostering an open and welcoming environment, we as contributo Examples of behavior that contributes to creating a positive environment include: -* Using welcoming and inclusive language -* Being respectful of differing viewpoints and experiences -* Gracefully accepting constructive criticism -* Focusing on what is best for the community -* Showing empathy towards other community members +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members Examples of unacceptable behavior by participants include: -* The use of sexualized language or imagery and unwelcome sexual attention or advances -* Trolling, insulting/derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a professional setting +- The use of sexualized language or imagery and unwelcome sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities diff --git a/CONTRIBUTING b/CONTRIBUTING.md similarity index 97% rename from CONTRIBUTING rename to CONTRIBUTING.md index 39f6dd5..81768e5 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING.md @@ -9,7 +9,7 @@ If you've noticed a bug or have a feature request, [make one](https://github.com generally best if you get confirmation of your bug or approval for your feature request this way before starting to code. -If you have a general question about MapTiler Geocoding Control, you can reach out to the +If you have a general question about MapTiler Geocoding Control, you can reach out to the [MapTiler documentation portal](https://documentation.maptiler.com/hc/en-us/search?query=geocoding) or contact [our support](https://documentation.maptiler.com/hc/en-us/requests/new), the issue tracker is only for bugs and feature requests. @@ -34,19 +34,17 @@ Install the development dependencies: npm install ``` -Then run the development mode, make sure, you export the [MapTiler Key](https://docs.maptiler.com/cloud/api/authentication-key/) as environment variable +Then run the development mode, make sure, you export the [MapTiler Key](https://docs.maptiler.com/cloud/api/authentication-key/) as environment variable ```sh VITE_API_KEY=YOUR_MAPTILER_API_KEY_HERE npm run dev ``` - ### Implement your fix or feature At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat: - ### Make a Pull Request At this point, you should switch back to your master branch and make sure it's @@ -69,5 +67,6 @@ git push --set-upstream origin 325-add-poi-filter Finally, go to GitHub and [make a Pull Request](https://github.com/maptiler/maptiler-geocoding-control/compare) ## Final word + Thank you one more time for your contribution. We try to deliver best user experience of geocoding, your contribution will make better experience to all users! diff --git a/SECURITY.md b/SECURITY.md index 75c7752..843973d 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -8,7 +8,6 @@ Following versions are supported with security updateds: | ------- | ------------------ | | 0.0.x | :white_check_mark: | - ## Reporting a Vulnerability To report Vulnerability, add [new issue](https://github.com/maptiler/maptiler-geocoding-control/issues/new/choose) to the issues tracker