From cbf6db196b59a9e94a0592dc962fbcb52d708a41 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Wed, 10 Apr 2024 15:23:10 +0200 Subject: [PATCH 1/2] chore: update support link --- CONTRIBUTING.md | 63 +------------------ clients/algoliasearch-client-python/setup.cfg | 4 +- .../algoliasearch-client-ruby/algolia.gemspec | 2 +- .../Sources/Core/Helpers/Extensions.swift | 2 +- playground/python/pyproject.toml | 2 +- snippets/python/pyproject.toml | 2 +- templates/python/pyproject.mustache | 2 +- tests/output/python/pyproject.toml | 2 +- 8 files changed, 9 insertions(+), 70 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a0cd38395b..bde23d076c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,64 +1,3 @@ # Contributing to the api-clients-automation repository -Welcome to the contributing guide for the api-clients-automation repository! - -You can find a lot more information about how to contribute [on our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction/) - -If this guide does not contain what you are looking for and thus prevents you from contributing, don't hesitate to [open an issue](https://github.com/algolia/api-clients-automation/issues/new/choose). - -## Reporting an issue - -Opening an issue is very effective way to contribute because many users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have important side effects for other users. - -Before reporting an issue, first check that there is not an already open issue for the same topic using the [issues page](https://github.com/algolia/api-clients-automation/issues). Don't hesitate to thumb up an issue that corresponds to the problem you have. - -Another element that will help us go faster at solving the issue is to provide a reproducible test case. - -## Code contribution - -For any code contribution, you need to: - -- Fork and clone the project -- Create a new branch for what you want to solve (fix/_issue-number_, feat/_name-of-the-feature_) -- Make your changes -- Open a pull request - -Then: - -- A team member will review the pull request -- Automatic checks will run - -When every check is green and a team member approves, your contribution is merged! 🚀 - -## Commit conventions - -This project follows the [conventional changelog](https://conventionalcommits.org/) approach. This means that all commit messages should be formatted using the following scheme: - -``` -type(scope): description -``` - -In most cases, we use the following types: - -- `fix`: for any resolution of an issue (identified or not) -- `feat`: for any new feature -- `refactor`: for any code change that neither adds a feature nor fixes an issue -- `docs`: for any documentation change or addition -- `chore`: for anything that is not related to the library itself (doc, tooling) - -Finally, if your work is based on an issue on GitHub, please add in the body of the commit message "fix #1234" if it solves the issue #1234 (read "[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)"). - -Some examples of valid commit messages (used as first lines): - -> - fix(javascript): ensure property X is valid -> - chore(deps): update dependency Y to v1.2.3 -> - fix(specs): add missing property -> - docs(contributing): reword release section - -## Requirements - -To run this project, you will need: - -- Node.js ≥ 18 – [nvm](https://github.com/creationix/nvm#install-script) is recommended -- [Yarn](https://yarnpkg.com) -- [Docker](https://docs.docker.com/desktop/install/mac-install/) +Read [our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction) diff --git a/clients/algoliasearch-client-python/setup.cfg b/clients/algoliasearch-client-python/setup.cfg index cb82558be2..9098d8d0c7 100644 --- a/clients/algoliasearch-client-python/setup.cfg +++ b/clients/algoliasearch-client-python/setup.cfg @@ -10,8 +10,8 @@ project_urls = description = ⚡️ A fully-featured and blazing-fast Python API client to interact with Algolia. long_description = file: README.md long_description_content_type = textmarkdown -maintainer = support team -maintainer_email = support@algolia.com +maintainer = support team +maintainer_email = https://support.algolia.com/hc/en-us/requests/new license = MIT license_files = LICENSE keywords = algolia, py, search, backend, hosted, cloud, full-text search, faceted search diff --git a/clients/algoliasearch-client-ruby/algolia.gemspec b/clients/algoliasearch-client-ruby/algolia.gemspec index b365e78e0a..d698f13fee 100644 --- a/clients/algoliasearch-client-ruby/algolia.gemspec +++ b/clients/algoliasearch-client-ruby/algolia.gemspec @@ -9,7 +9,7 @@ Gem::Specification.new do |s| s.version = Algolia::VERSION s.platform = Gem::Platform::RUBY s.authors = ['Algolia'] - s.email = ['support@algolia.com'] + s.email = ['https://support.algolia.com/hc/en-us/requests/new'] s.homepage = 'https://github.com/algolia/algoliasearch-client-ruby' s.summary = 'A simple Ruby client for the algolia.com REST API' s.description = 'A simple Ruby client for the algolia.com REST API' diff --git a/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift b/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift index d70a11d81e..08ebd66001 100644 --- a/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift +++ b/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift @@ -258,7 +258,7 @@ public extension URLRequest { case invalidQueryItems public var errorDescription: String? { - let contactUs = "Please contact support@algolia.com if this problem occurs." + let contactUs = "Please contact https://support.algolia.com/hc/en-us/requests/new if this problem occurs." switch self { case let .badHost(host): return "Bad host: \(host). Will retry with next host. " + contactUs diff --git a/playground/python/pyproject.toml b/playground/python/pyproject.toml index 118571e7b2..0a0a043ec6 100644 --- a/playground/python/pyproject.toml +++ b/playground/python/pyproject.toml @@ -2,7 +2,7 @@ name = "app" version = "0.0.1" description = "playground for the algoliasearch-client-python repository" -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" readme = "README.md" homepage = "https://www.algolia.com" diff --git a/snippets/python/pyproject.toml b/snippets/python/pyproject.toml index 75bb499bd3..783f6a6d53 100644 --- a/snippets/python/pyproject.toml +++ b/snippets/python/pyproject.toml @@ -2,7 +2,7 @@ name = "snippets" version = "0.0.1" description = "snippets for the python api client" -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" homepage = "https://www.algolia.com" repository = "https://github.com/algolia/api-clients-automation" diff --git a/templates/python/pyproject.mustache b/templates/python/pyproject.mustache index ebd49eeb1c..e1b70f68ff 100644 --- a/templates/python/pyproject.mustache +++ b/templates/python/pyproject.mustache @@ -2,7 +2,7 @@ name = "algoliasearch" version = "{{{packageVersion}}}" description = "A fully-featured and blazing-fast Python API client to interact with Algolia." -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" readme = "README.md" homepage = "https://www.algolia.com" diff --git a/tests/output/python/pyproject.toml b/tests/output/python/pyproject.toml index 113396dc36..039be6057f 100644 --- a/tests/output/python/pyproject.toml +++ b/tests/output/python/pyproject.toml @@ -2,7 +2,7 @@ name = "tests" version = "0.0.1" description = "common test suite for the Python API client" -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" homepage = "https://www.algolia.com" repository = "https://github.com/algolia/api-clients-automation" From ccdb22251cccf62d9000f8d4db05f5386a40b848 Mon Sep 17 00:00:00 2001 From: shortcuts Date: Wed, 5 Jun 2024 10:04:15 +0200 Subject: [PATCH 2/2] chore: update links --- CONTRIBUTING.md | 55 ++++++++++++++++++- .../client-common/src/transporter/errors.ts | 2 +- clients/algoliasearch-client-python/setup.cfg | 3 +- .../algoliasearch-client-ruby/algolia.gemspec | 3 +- .../Sources/Core/Helpers/Extensions.swift | 2 +- playground/python/pyproject.toml | 2 +- snippets/python/pyproject.toml | 2 +- templates/python/pyproject.mustache | 2 +- tests/output/python/pyproject.toml | 2 +- 9 files changed, 62 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bde23d076c..e60abb1326 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,56 @@ # Contributing to the api-clients-automation repository -Read [our documentation](https://api-clients-automation.netlify.app/docs/contributing/introduction) +Welcome to the contributing guide for the api-clients-automation repository! + +Please read [our contributing guides](https://api-clients-automation.netlify.app/docs/contributing/introduction/) for advanced usage. + +If you can't find what you are looking for, please [open an issue](https://github.com/algolia/api-clients-automation/issues/new/choose). + +## Reporting an issue + +Opening an issue is very effective way to contribute because many users might also be impacted. We'll make sure to fix it quickly if it's technically feasible and doesn't have important side effects for other users. + +Before reporting an issue, first check that there is not an already open issue for the same topic using the [issues page](https://github.com/algolia/api-clients-automation/issues). Don't hesitate to thumb up an issue that corresponds to the problem you have. + +Another element that will help us go faster at solving the issue is to provide a reproducible test case. + +## Code contribution + +For any code contribution, you need to: + +- Fork and clone the project +- Make your changes +- Open a pull request + +## Commit conventions + +This project follows the [conventional changelog](https://conventionalcommits.org/) approach. This means that all commit messages should be formatted using the following scheme: + +``` +type(scope): description +``` + +In most cases, we use the following types: + +- `fix`: for any resolution of an issue (identified or not) +- `feat`: for any new feature +- `refactor`: for any code change that neither adds a feature nor fixes an issue +- `docs`: for any documentation change or addition +- `chore`: for anything that is not related to the library itself (doc, tooling) + +Finally, if your work is based on an issue on GitHub, please add in the body of the commit message "fix #1234" if it solves the issue #1234 (read "[Closing issues using keywords](https://help.github.com/en/articles/closing-issues-using-keywords)"). + +Some examples of valid commit messages (used as first lines): + +> - fix(javascript): ensure property X is valid +> - chore(deps): update dependency Y to v1.2.3 +> - fix(specs): add missing property +> - docs(contributing): reword release section + +## Requirements + +To run this project, you will need: + +- Node.js ≥ 20 – [nvm](https://github.com/creationix/nvm#install-script) is recommended +- [Yarn](https://yarnpkg.com) +- [Docker](https://docs.docker.com/desktop/install/mac-install/) diff --git a/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/errors.ts b/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/errors.ts index 80c55e8d79..20e2e728cd 100644 --- a/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/errors.ts +++ b/clients/algoliasearch-client-javascript/packages/client-common/src/transporter/errors.ts @@ -25,7 +25,7 @@ export class ErrorWithStackTrace extends AlgoliaError { export class RetryError extends ErrorWithStackTrace { constructor(stackTrace: StackFrame[]) { super( - 'Unreachable hosts - your application id may be incorrect. If the error persists, please create a ticket at https://support.algolia.com/ sharing steps we can use to reproduce the issue.', + 'Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.', stackTrace, 'RetryError' ); diff --git a/clients/algoliasearch-client-python/setup.cfg b/clients/algoliasearch-client-python/setup.cfg index 9098d8d0c7..ea052a41d2 100644 --- a/clients/algoliasearch-client-python/setup.cfg +++ b/clients/algoliasearch-client-python/setup.cfg @@ -10,8 +10,7 @@ project_urls = description = ⚡️ A fully-featured and blazing-fast Python API client to interact with Algolia. long_description = file: README.md long_description_content_type = textmarkdown -maintainer = support team -maintainer_email = https://support.algolia.com/hc/en-us/requests/new +maintainer = support team license = MIT license_files = LICENSE keywords = algolia, py, search, backend, hosted, cloud, full-text search, faceted search diff --git a/clients/algoliasearch-client-ruby/algolia.gemspec b/clients/algoliasearch-client-ruby/algolia.gemspec index d698f13fee..7fbf05c642 100644 --- a/clients/algoliasearch-client-ruby/algolia.gemspec +++ b/clients/algoliasearch-client-ruby/algolia.gemspec @@ -8,8 +8,7 @@ Gem::Specification.new do |s| s.name = 'algolia' s.version = Algolia::VERSION s.platform = Gem::Platform::RUBY - s.authors = ['Algolia'] - s.email = ['https://support.algolia.com/hc/en-us/requests/new'] + s.authors = ['https://alg.li/support'] s.homepage = 'https://github.com/algolia/algoliasearch-client-ruby' s.summary = 'A simple Ruby client for the algolia.com REST API' s.description = 'A simple Ruby client for the algolia.com REST API' diff --git a/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift b/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift index 08ebd66001..c0db9bbfed 100644 --- a/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift +++ b/clients/algoliasearch-client-swift/Sources/Core/Helpers/Extensions.swift @@ -258,7 +258,7 @@ public extension URLRequest { case invalidQueryItems public var errorDescription: String? { - let contactUs = "Please contact https://support.algolia.com/hc/en-us/requests/new if this problem occurs." + let contactUs = "Please contact https://alg.li/support if this problem occurs." switch self { case let .badHost(host): return "Bad host: \(host). Will retry with next host. " + contactUs diff --git a/playground/python/pyproject.toml b/playground/python/pyproject.toml index 0a0a043ec6..d861032aa1 100644 --- a/playground/python/pyproject.toml +++ b/playground/python/pyproject.toml @@ -2,7 +2,7 @@ name = "app" version = "0.0.1" description = "playground for the algoliasearch-client-python repository" -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" readme = "README.md" homepage = "https://www.algolia.com" diff --git a/snippets/python/pyproject.toml b/snippets/python/pyproject.toml index 783f6a6d53..cd5cefda18 100644 --- a/snippets/python/pyproject.toml +++ b/snippets/python/pyproject.toml @@ -2,7 +2,7 @@ name = "snippets" version = "0.0.1" description = "snippets for the python api client" -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" homepage = "https://www.algolia.com" repository = "https://github.com/algolia/api-clients-automation" diff --git a/templates/python/pyproject.mustache b/templates/python/pyproject.mustache index e1b70f68ff..cbb145cb3b 100644 --- a/templates/python/pyproject.mustache +++ b/templates/python/pyproject.mustache @@ -2,7 +2,7 @@ name = "algoliasearch" version = "{{{packageVersion}}}" description = "A fully-featured and blazing-fast Python API client to interact with Algolia." -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" readme = "README.md" homepage = "https://www.algolia.com" diff --git a/tests/output/python/pyproject.toml b/tests/output/python/pyproject.toml index 039be6057f..53eac82216 100644 --- a/tests/output/python/pyproject.toml +++ b/tests/output/python/pyproject.toml @@ -2,7 +2,7 @@ name = "tests" version = "0.0.1" description = "common test suite for the Python API client" -authors = ["Algolia Team "] +authors = ["Algolia Team "] license = "MIT" homepage = "https://www.algolia.com" repository = "https://github.com/algolia/api-clients-automation"