Skip to content

HowTo: Contribute to READ COM Gallery

Jump to bottom
George Birbilis edited this page May 3, 2023 · 2 revisions

  1. Create a free account on GitHub

    You can do this at https://github.com › join

  2. Login to your GitHub account

    Can do this from any page on GitHub from the icon at the top-right corner. It shows:

    image

  3. Fork the official READ-COM Gallery Git repository

    Press the Fork button at the top-right of the official repository

    image

  4. Visit your forked READCOM_Gallery repository page (the url will be in this form: https://github.com/YOUR_USERNAME_HERE/READCOM_Gallery)

  5. You can rename (also used to move things around, which will create "folders" as needed), delete and add files to your forked repository directly from the web interface

    Alternatively you can clone your forked repository locally using a Git client application. An easy one that is integrated with GitHub website is the GitHub Desktop app

    image

  6. Once you've cloned locally your forked repository, you can add/delete files and created folders directly under the folder where you cloned your forked repository in your local file system.

    Renamed files/folders aren't detected though usually by Git clients (unless they run in the background and monitor the file system constantly for changes) and they have a separate Git rename action (e.g. TortoiseGit client has such). The rename action is also used in such clients to move files between folders: you enter the relative path to where your file will move, e.g. "../test/someImage.png" at a Git rename action would mean that the file you rename will take the someImage.png name goes into a subdirectory - creating it if needed - named test that is a sibling of the file's current folder - this is cause ".." means one level higher in the filesystem. Note the use of "/" instead of "" for separating folder names in a path. Some Git clients may require that, since Git is of Unix/Linux origin which uses / instead of .

  7. When you have enough changes you can commit them as a version-controlled batch (called a "commit") to your local clone of your remote repository (the one you forked from the official READCOM_Gallery repository)

  8. You can "push" several commits from the local clone of your repository to the remote one on GitHub (for both backup and sharing with others reasons) via your Git client (they may have "push" listed as an option under a more general "sync" action)

  9. You can periodically "pull" changes from your remote repository to your local one (some Git clients may have this listed as an options under a more general "sync" action). This is useful if you have done some changes using the web interface for example, or if you "merged" changes (see the "Contribute" button on a repository) from the official repository of READCOM_Gallery to your fork of it on GitHub. It is best to always pull remote changes before doing edits locally. Ideally after first merging into your remote repository any changes from the official repository.

  10. To propose inclusion of your changes to the official repository use the "Contribute" button and issue a merge request. Note that for any media asset contributions to be accepted, metadata with license (has to be a non-restricted one) and attribution info for each media asset has to be noted (at a METADATA.yaml file, see other ones in the gallery for the syntax). For story files (.readcom) too please provide title/keywoards/license/attribution info via metadata file (one per folder).

Clone this wiki locally