For contributing to this repository, a GitHub account is required. New contributions will open a Pull Request (PR) with your suggested changes from a fork (of this repository) added to your personal account. Contributions can be made directory from the GitHub UI, without the need to download additional software. Once submitted, your PR will be reviewed and either accepted or you will be notified of any changes required.
Below, guides are provided for the for the following contribution types:
To add a new record, rename and edit the record template as shown in the steps below.
Click on the template.yaml file in the Code view and then click the edit
button. A new fork may be created.
Click on the file name and change template.yaml to records/<YOUR FILE NAME>. The forward slash (/) after records is important in order to place
the new file in the records folder.
Choose a file name that represents the software, but avoid using spaces. For
example my_software.yaml.
All required fields must be completed. These are marked as REQUIRED in the
comments on the template.
Delete options from lists, as appropriate. and enter data into string fields. Where a string field has limited valid values, they will be listed in the field's comment.
Optional fields can be deleted; however, please endeavour to complete as many fields as possible.
The description field can contain paragraphs and blank lines. In the record, one blank line represents a new paragraph and two blank lines produces a blank line when rendered. Ensure the indentation is the same for all of the text.
Alternatively, for short descriptions, remove the block indicator (>-) and
add the text like a normal string field.
When ready click the Commit changes... button. A pop-up will open where you can add a short name for the new commit. Don't write in the "Extended description" box.
Now click the Propose changes button, followed by the Create pull request button, which will open the pull request template.
A template, in GitHub Markdown format has been prepared to help describe the changes made. Please complete this form to the best of your ability. A preview of the rendered output can be seen by clicking the Preview tab.
Once the form is completed click the Create pull request button. Leave the Allow edits by maintainers box ticked. Your new pull request is now created and will be reviewed as soon as possible.
The steps below provide a guide for editing an existing software record.
Open the record template (template.yaml) for use as a reference. In the
example below, the template is opened in a separate browser tab.
To find a record file based on the title of the software, use the File
Finder bar. Enter the software name using the format Title: <SOFTWARE_TITLE> and press enter. The search should return a snippet of a
file containing the search term. Click on the file path (records\****.yaml)
to open it.
Once the file has opened, ensure that the current branch is changed to
main. Without this step, the file can not be edited.
To start editing the file, click the edit button. A new fork may be created.
Use the record template (opened in step 1) to update fields and options in the existing record's file. Take care not to remove any required fields and to keep the indentation correct. See step 3 of the "Adding a new record" guide for further details.
When ready, click the Commit changes... button and a pop-up will open. Don't write in the "Extended description" box.
Now click the Propose changes button, followed by the Create pull request button, which will open the pull request template.
A template, in GitHub Markdown format has been prepared to help describe the changes made. Please complete this form to the best of your ability.
Once the form is completed click the Create pull request button. Leave the Allow edits by maintainers box ticked. Your new pull request is now created and will be reviewed as soon as possible.
