-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
82 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -26,19 +26,19 @@ All types of contributions are encouraged and valued. See the [table of contents | |
| ## Code of conduct | ||
|
|
||
| This project and everyone participating in it is governed by the | ||
| [Connery code of conduct](https://github.com/connery-io/connery/blob/main/CODE_OF_CONDUCT.md). | ||
| [Connery code of conduct](https://github.com/connery-io/connery-sdk/blob/main/CODE_OF_CONDUCT.md). | ||
| By participating, you are expected to uphold this code. Please report unacceptable behavior | ||
| to [email protected]. | ||
|
|
||
| ## I have a question | ||
|
|
||
| > If you want to ask a question, we assume that you have read the available [Documentation](https://sdk.connery.io). | ||
| Before you ask a question, it is best to search for existing [Discussions](https://github.com/connery-io/connery/discussions) that might help you. In case you have found a suitable discussion and still need clarification, you can write your question in this discussion. It is also advisable to search the internet for answers first. | ||
| Before you ask a question, it is best to search for existing [Discussions](https://github.com/connery-io/connery-sdk/discussions) that might help you. In case you have found a suitable discussion and still need clarification, you can write your question in this discussion. It is also advisable to search the internet for answers first. | ||
|
|
||
| If you still feel the need to ask a question and need clarification, we recommend the following: | ||
|
|
||
| - Open a [Discussion](https://github.com/connery-io/connery/discussions/new). | ||
| - Open a [Discussion](https://github.com/connery-io/connery-sdk/discussions/new). | ||
| - Provide as much context as you can about what you're running into. | ||
| - Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant. | ||
|
|
||
|
|
@@ -58,7 +58,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform | |
|
|
||
| - Make sure that you are using the latest version. | ||
| - Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://sdk.connery.io). If you are looking for support, you might want to check [this section](#i-have-a-question)). | ||
| - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/connery-io/connery/issues?q=label%3Abug). | ||
| - To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/connery-io/connery-sdk/issues?q=label%3Abug). | ||
| - Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue. | ||
| - Collect information about the bug: | ||
| - Stack trace (Traceback) | ||
|
|
@@ -73,7 +73,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform | |
| We use GitHub issues to track bugs and errors. If you run into an issue with the project: | ||
|
|
||
| - Open an [Issue](https://github.com/connery-io/connery/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) | ||
| - Open an [Issue](https://github.com/connery-io/connery-sdk/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.) | ||
| - Explain the behavior you would expect and the actual behavior. | ||
| - Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case. | ||
| - Provide the information you collected in the previous section. | ||
|
|
@@ -92,12 +92,12 @@ This section guides you through submitting an enhancement suggestion for Connery | |
|
|
||
| - Make sure that you are using the latest version. | ||
| - Read the [documentation](https://sdk.connery.io) carefully and find out if the functionality is already covered, maybe by an individual configuration. | ||
| - Perform a [search](https://github.com/connery-io/connery/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. | ||
| - Perform a [search](https://github.com/connery-io/connery-sdk/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one. | ||
| - Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library. | ||
|
|
||
| #### How do I submit a good enhancement suggestion? | ||
|
|
||
| Enhancement suggestions are tracked as [GitHub issues](https://github.com/connery-io/connery/issues). | ||
| Enhancement suggestions are tracked as [GitHub issues](https://github.com/connery-io/connery-sdk/issues). | ||
|
|
||
| - Use a **clear and descriptive title** for the issue to identify the suggestion. | ||
| - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. | ||
|
|
@@ -119,11 +119,11 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/conner | |
|
|
||
| ### Adding plugin to the list of plugins | ||
|
|
||
| If you have a plugin you would like to add to the [list of plugins](https://sdk.connery.io/docs/plugins/), please open a pull request to update the [./apps/docs/docs/plugins/index.mdx](https://github.com/connery-io/connery/blob/main/apps/docs/docs/plugins/index.mdx) file in this repository. | ||
| If you have a plugin you would like to add to the [list of plugins](https://sdk.connery.io/docs/plugins/), please open a pull request to update the [./apps/docs/docs/plugins/index.mdx](https://github.com/connery-io/connery-sdk/blob/main/apps/docs/docs/plugins/index.mdx) file in this repository. | ||
|
|
||
| ### Adding client to the list of clients | ||
|
|
||
| If you have a client you would like to add to the [list of clients](https://sdk.connery.io/docs/clients/), please open a pull request to add a new page to the [./apps/docs/docs/clients/](https://github.com/connery-io/connery/blob/main/apps/docs/docs/clients/) folder in this repository. | ||
| If you have a client you would like to add to the [list of clients](https://sdk.connery.io/docs/clients/), please open a pull request to add a new page to the [./apps/docs/docs/clients/](https://github.com/connery-io/connery-sdk/blob/main/apps/docs/docs/clients/) folder in this repository. | ||
|
|
||
| ## Attribution | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| # Introduction | ||
|
|
||
| Check out the [README](https://github.com/connery-io/connery#readme) file of the GitHub repository for an introduction to Connery SDK. | ||
| Check out the [README](https://github.com/connery-io/connery-sdk#readme) file of the GitHub repository for an introduction to Connery SDK. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.