PACT Online Catalog
This repository holds the PACT Online Catalog.
Contribute
To contribute to the PACT Online Catalog with an Data Model Extension, a Conformant Solution, or a Conformance Test Result, please follow these steps:
pact-catalog
repository and clone it into your local machine
1. Fork the If you have GitHub CLI tools installed, open a terminal window and run
gh repo fork https://github.com/sine-fdn/pact-catalog.git --clone
Otherwise, navigate to the pact-catalog repository and fork it in your browser (instructions can be found here).
Then, open a terminal window and run
git clone [email protected]:<your-github-id>/pact-catalog.git
2. Checkout a new branch with your institution's name
Run
git checkout -b <your-name>
3. Follow the contribution-specific tests
If you want to contribute an Data Model Extension, please follow these steps.
If you want to contribute a Conformant Solution, please follow these steps.
If you want to contribute a Conformance Test Result, please follow these steps.
Once you have done that, please proceed to the next step.
4. Commit and push your branch
From the parent directory of the repository, run
git add .
git commit -m "feat: <commit-message>"
git push origin <your-name>
Please replace <commit-message>
with a short description, such as add <extension-id> extension
, add <your-solution-id> solution
, or add <tested-solution-id> test result
.
5. Open a Pull Request
Go to the original pact-catalog repository, choose the Pull requests
tab and click the New pull request
button.
Open a Pull Request to merge the branch <your-name>
from your forked repository into the main
branch of the pact-catalog
repository. Instructions on how to open Pull Requests accross forks can be found here.
Please note: All text between angle brackets (< >
) should be replaced by actual values. Please make sure that the values replacing <your-name>
, <extenion-id>
, <extension-version>
,<your-solution-id>
, and <your-solution-version>
remain consistent. None should contain whitespaces and <your-solution-version>
should follow the X.Y.Z
format.
Your Pull Request will be reviewed and your solution added to the PACT Online Catalog as soon as possible.
NOTE: Conformance test results are shown in the
Conformance
tab of a specific solution's page. If the tested solution has not yet been added to the catalog, the test data will not be visible. Rest assured, however, that it is included in the catalog and will become visible as soon as the tested solution is added.