Open-Source Contribution

Licenses, reading a codebase you did not write, issues and bug reports, pull requests, code review and style, and a first contribution to StepVioz.

  1. 1

    What open source is

    Code anyone may read, use, change and share; the licenses that allow it, and the files every project has.

  2. 2

    Reading a codebase

    Find your way around code you did not write: start at the entry point, follow one feature, and search.

  3. 3

    Issues and bug reports

    Choose an issue to work on, and write a bug report with a minimal reproduction that a maintainer can act on.

  4. 4

    Pull requests

    Fork, branch, commit, push and open a pull request; pass the checks, answer the review, and stay up to date.

  5. 5

    Code review and style

    What reviewers look for, how style guides and linters help, and how to give and take review well.

  6. 6

    Your first contribution

    Contribute to StepVioz itself: how the project is laid out, and how to add a practice problem.