Updates and Corrections
Community contributions keep the catalog updated and relevant. If you have found a bug or omission in the MP catalog the below steps can help you quickly submit a fix and keep the community operating at its best.
- Login
- Locate the Error
- Check for Duplicate PRs
- Make Corrections
- Propose Changes
- Submit Pull Requests
- Wait for Approval / Changes
To submit any changes or updates to the catalog, you need to be logged into GitHub. If you do not yet have a GitHub account you can quickly join here.
The MP Catalog has a basic structure, with each management pack's details existing in a dedicated folder. If you cannot find what you are looking for GitHub's search functionality can also be used to locate items throughout the repository.
In this example, we make corrections to the Community.DataOnDemand MP details. The following steps cover how to add a Description property within the details.json.
Before submitting a new change, it is a good idea to check the open Pull Request (PR) items, as someone from the community may have already submitted an update. Any open PRs can be viewed by clicking 'Pull requests' on the top of the page. Each pull request should have a description covers what is changing, this can be used to identify if the update has already been submitted.
Once you have located the file, you are presented with a view similar to the screenshot below. To start making edits, click the pencil in the upper left corner of the document.
The document becomes editable, at which point you can make the required changes.
If this is the first edit you have made, GitHub may show a message similar to the below, automatically creating a fork and branch for the edits.
Once you have completed the edits, it is time to propose the file change and commit the changes. On the bottom of the document, fields are available to provide a title and comments. Similar to the example below, providing any details available can assist the moderators in approving the changes.
After clicking 'Propose Changes', GitHub directs you to a page that compares the submitted changes to the current repository. If everything looks correct, click the 'Create pull request' button, this creates a new Pull Request (PR) that will be sent over to the moderators for approval.
That is about it, all that is left to do is confirm that the Continous Integration checks pass and await feedback from the moderators. If changes are requested GitHub notifies you at the registered e-mail by default.
Immediately after the Pull Request (PR) is submitted, a status of pending may show on the Continous Integration check(s). Wait until this status changed to "All checks have passed" before considering the PR complete.
The snippet below shows that all of the required checks have passed. If the checks have failed, you can view additional details by clicking the 'Details' link. Modifying the files in your PR re-starts the checks, please make the needed corrections, or place a note in the comments as to why it should remain in the current format.
