Skip to content

CONTRIB_SOLUTION.md

Latest commit

 

History

History
80 lines (51 loc) · 3.34 KB

CONTRIB_SOLUTION.md

File metadata and controls

80 lines (51 loc) · 3.34 KB

Contribute a PACT Conformant Solution

To contribute a PACT Conformant Solution, please follow these steps:

NOTE: The following steps presuppose that you have already forked and cloned the pact-catalog repository. If that is not the case, please go back to the main instructions and follow them in order.

1. Create a new solution path in the solutions directory

From the parent directory of your local repository run

Please note: All text between angle brackets (< >) should be replaced by actual values. Please make sure that the values replacing <your-user-id>, <your-solution-id> and <your-solution-version> only include lowercase letters and dashes (instead of whitespace). The value replacing <your-solution-version> should follow the X.Y.Z format. Please make sure that these remain consistent.

mkdir -p catalog/solutions/<your-solution-id>/<your-solution-version>

E.g., mkdir -p catalog/solutions/example-solution/0.0.0

2. Create a new json file in your solution's directory

From the parent directory of your local repository run

touch catalog/solutions/<your-solution-id>/<your-solution-version>/solution.json

E.g., touch catalog/solutions/example-solution/0.0.0/solution.json

3. Fill in your solution's details

Open the json file created in step 4. and fill it by adapting the following structure:

{
  "id": "<your-solution-id>", // e.g. 'Example Solution' has solution id "example-solution"
  "name": "<Your Solution Name>", // e.g. "Example Solution"
  "version": "<your-solution-version>", // e.g. "0.0.0"
  "website": "<your-solution-website>",
  "provider_id": "<your-user-id>", // e.g. 'ABC Corp' has user id "abc" or "abc-corp"
  "summary": "<summary>"
}

Note: The "summary" field is optional but highly recommended.

If your solution supports Data Model Extensions, please include also the field "extensions", based on the following structure:

  "extensions": [
    {
      "namespace": "@<user-id>", // the id of the user that developed the extension
      "extension_name": "<extension-id>",
      "version": "<extension-version>"
    },
  ],

If your solution was conceived to be used in specific industries — and especially if it supports Data Model Extensions — please include the field "industries", based on the following structure:

  "industries": ["<industry>"],

Please refer to this example to see how your solution.json file should look like.

4. Contribute a Conformance Test Result

NOTE: If your solution has not yet been tested for conformance, please skip this step.

If have already tested your solution for conformance with the Pathfinder Framework, please contribute a Conformance Test Result by following these instructions.

5. Commit your branch, push it, and open a Pull Request

Please continue from step 6 of the main instructions.

Your Pull Request will be reviewed and your solution added to the PACT Online Catalog as soon as possible.

NOTE: By submitting a Conformant Solution you acknowledge that you have read and accepted the Catalog's Terms and Conditions.