Contributing to How-to Cards#

How-to Cards are managed in LCSB GitLab group lcsb/howto, and developed using git and Markdown.

To get a login in LCSB GitLab, you will need a LUMS account.

If you are not familiar with git and want to edit a How-to Card, please refer to the following guides:

• How-to Cards formatting with Markdown explains how the source code of the cards is written
• Contributing via GitLab web interface explains a straightforward way to submit your edits to the How-to Cards

If you are familiar with git: the contributions follow the usual git workflow: You commit your changes into the target repository, open a merge request, and How-to Cards maintainers will review and merge your request as soon as possible. If you are familiar with git, the documentation present in the GitLab group page should provide you with sufficient guidance.

We maintain the documentation of the best practices for contributing with git:

• use of the GitLab Web IDE to make more complex changes
• installation any of the available git clients
• setting up a GitLab fork with mirroring
• setting up SSH key authentication
• making changes using VSCode
• contributing to other’s unfinished merge requests

If you were asked to review a merge request in How-to Cards repository:

• reviewing merge requests

All cards relevant to the contribution process are collected in the contribution category.