Skip to content

How to contribute to the sciCORE Documentation

Info

Contributions are welcome! To help you getting started, we put together the tips and suggestions below.

Contributions can be made in a number of ways, a few examples are:

  1. Documentation improvements suggestions by creating a GitLab issue – please include as much detail as you can.
  2. Active participation by adding to or updating content (requires familiarity with git and Markdown)
  3. Submit feedback via issues, tickets, or email.

Creating an issue

Whether you want to submit feedback or actively contribute to the documentation page, the best way to start your contribution is to create a new issue on in the gitlab project as described below. This will help the team work on your suggested improvements in a timely and organized manner.

How to create an issue

  1. Go to git repository (after logging in with your UniBas account)
  2. Go to Issues
  3. Select New item
  4. Select the template sciCORE documentation issue template
  5. Fill in the template and include as much detail as you can

Issue naming convention

To help to categorize issues, we suggested a few conventions to name issues. When creating an issue, please follow the naming instructions below:

  1. Start the issue name with a topic
  2. Use slashes to separate parts of your issues names.
  3. Do not start your name with numbers and special characters
  4. Keep them short

Info

For example: fixing-typos or create-cheatsheet

Contributing directly (requires git and Markdown knowledge)

If you are comfortable editing Markdown, feel free to edit files either using the web interface or locally after you have cloned the repo. The main README contains the instructions to build the site locally. Please commit you changes to a branch with informative commit messages.

  1. Access the gitlab project page.
  2. Login using your university account credentials.
  3. Create an issue following the instructions above.
  4. Create a branch from the issue.
  5. Edit.
  6. Submit a merge request.

Your merge request will be reviewed by sciCORE and may be included in a future release of the documentation.

Warning

Before you start editing, please refer to the README.md file for guidelines and formatting styles used in the current documentation project.