Skip to content

Latest commit

 

History

History
32 lines (20 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

32 lines (20 loc) · 1.97 KB
Raw

Contribution Guide

Contributions to this repository fall within one of two categories:

  1. Contributions to the training material itself, or
  2. Contributions as part of the "contribution exercise" which is part of the training course.

Contributions to the training material

Updates of existing material

Please follow the steps below for contributions to the training material hosted within this repository:

  1. Create an issue describing the changes you are intending to make
  2. Fork the repository and make your changes or add new content
  3. Describe your changes clearly in your commit messages
  4. Create a pull request
  5. The pull request will be reviewed by an appointed team with representatives from ABB, Ericsson, Saab and Volvo group
  6. Once the pull request gets approved, it will be merged

If you are new to GitHub and want to learn about how to perform the steps listed above, please review the excellent GitHub documentation.

Changes of the structure or adding new material

Changes of the structure of the material, for instance splitting text into separate files or adding content in new files, requires corresponding changes in the training course player (PECA Player). These changes must be made separately and cannot be controlled from this GitHub repository. Therefore, if you make such changes, please point this out in your PR so that the new content will be reviewed and added to the course player.

Contributions as part of the "contribution exercise"

The training course on contributions includes an exercise which tasks learners to make a sample contribution to this repository. Learners should follow the same steps as listed above, subject to the following two differences:

  • Any changes should only be made to the sample file Contributions-exercise.md,
  • The PR will be reviewed but eventually closed instead of merged.