Skip to content

Changes

Page history
Update Contributing a New Adapter authored by Michael Evenchick's avatar Michael Evenchick
Show whitespace changes
Inline Side-by-side
Contributing-a-New-Adapter.md
View page @ 34f99252
......@@ -56,8 +56,9 @@ Before contributing a new adapter, be sure you have verified there is a need for
2. Build the new adapter using the [Itential Adapter Builder](https://adapters.itential.io).
3. Install the generated adapter into your IAP environment following the process to install the adapter.
4. Confirm the adapter is available in IAP by creating a service instance of the adapter.
5. In the package.json, under the Keywords section you should add information on categorization. This means adding the one or two words in the category to the list of keywords. This should follow the "Adapter" keyword. You can also verify the Adapter name keywords. Often Vendor and System are combined into one keyword and it may be better to make multiple keywords for these.
6. Also in the package.json, the repository.url and homepage urls are generic. You should add the category to the path after /adapter/ as follows - git@gitlab.com:itentialopensource/adapters/**telemetry-analytics/**adapter-sevone.git. Notice if the category is multiple words, the words should be separated by a -
5. Categorize the adapter
* In the package.json, under the Keywords section you should add information on categorization. This means adding the one or two words in the category to the list of keywords. This should follow the "Adapter" keyword. You can also verify the Adapter name keywords. Often Vendor and System are combined into one keyword and it may be better to make multiple keywords for these.
* Also in the package.json, the repository.url and homepage urls are generic. You should add the category to the path after /adapter/ as follows - git@gitlab.com:itentialopensource/adapters/**telemetry-analytics/**adapter-sevone.git. Notice if the category is multiple words, the words should be separated by a -
## Step 3 - GitLab Project Creation
......@@ -82,12 +83,12 @@ This assumes you have installed git in your local environment.
The Adapters use a **_master_** branch and NOT the main branch so please follow these instructions In your environment
```bash
1. cd existing_folder where you installed the adapter
2. git init
3. git remote add origin <link to the repo you created>
4. git add
5. git commit -m "Initial commit"
6. git push -u origin master
cd existing_folder where you installed the adapter
git init
git remote add origin <link to the repo you created>
git add
git commit -m "Initial commit"
git push -u origin master
```
## Step 5 - Adapter Team Review
......
......