Merge branch 'main' into 404

.coveragerc

@@ -0,0 +1,5 @@
+[report]
+exclude_lines =
+    pragma: no cover
+    if\s+(typing\.)?TYPE_CHECKING:
+    \.\.\.

.github/linters/.ruff.toml

@@ -61,6 +61,8 @@ ignore = [
     "FBT002",
     # builtin-attribute-shadowing (not an issue)
     "A003",
+    # implicit-return (can add a return even though all cases are covered)
+    "RET503",
     # superfluous-else-return (sometimes it's more readable)
     "RET505",
     # superfluous-else-raise (sometimes it's more readable)

.github/workflows/issue.yml

@@ -9,7 +9,7 @@ jobs:
   add-to-project:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/add-to-project@v0.4.1
+      - uses: actions/add-to-project@v0.5.0
         with:
           project-url: https://github.com/orgs/Safe-DS/projects/2
           github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

.github/workflows/main.yml

@@ -17,4 +17,6 @@ jobs:
       working-directory: .
       python-version: ${{ matrix.python-version }}
       module-name: safeds
-      coverage: ${{ matrix.python-version == '3.10' }}
+      coverage: ${{ matrix.python-version == '3.11' }}
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/megalinter.yml

@@ -7,5 +7,9 @@ on:
 jobs:
   megalinter:
     uses: lars-reimann/.github/.github/workflows/megalinter-reusable.yml@main
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
     secrets:
       PAT: ${{ secrets.PAT }}

.github/workflows/pr.yml

@@ -21,4 +21,6 @@ jobs:
       working-directory: .
       python-version: ${{ matrix.python-version }}
       module-name: safeds
-      coverage: ${{ matrix.python-version == '3.10' }}
+      coverage: ${{ matrix.python-version == '3.11' }}
+    secrets:
+      CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -45,5 +45,5 @@ report/
 megalinter-reports/
 
 # Other
-.DS_Store/
+.DS_Store
 *.log

.mega-linter.yml

@@ -17,5 +17,4 @@ JSON_PRETTIER_FILE_EXTENSIONS:
 
 # Commands
 PRE_COMMANDS:
-  - command: npm install @lars-reimann/prettier-config
-    cwd: workspace
+  - command: npm i @lars-reimann/prettier-config

docs/README.md

@@ -3,7 +3,7 @@
 [![PyPI](https://img.shields.io/pypi/v/safe-ds)](https://pypi.org/project/safe-ds)
 [![Main](https://github.com/Safe-DS/Stdlib/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Stdlib/actions/workflows/main.yml)
 [![codecov](https://codecov.io/gh/Safe-DS/Stdlib/branch/main/graph/badge.svg?token=HVRP1633B1)](https://codecov.io/gh/Safe-DS/Stdlib)
-[![Documentation Status](https://readthedocs.org/projects/safe-ds-stdlib/badge/?version=stable)](https://stdlib.safe-ds.com)
+[![Documentation Status](https://readthedocs.org/projects/safe-ds-stdlib/badge/?version=stable)](https://stdlib.safeds.com)
 
 A user-friendly library for Data Science (DS) in Python.
 
@@ -17,11 +17,7 @@ Instead of implementing DS methods from scratch, we use established DS libraries
 
  For more specialized tasks, we recommend using these or other DS libraries directly.
 
-Note that this library is still in development and not yet ready for production. Expect breaking changes in the future without a major version bump (while in the `0.y.z` version range). Feedback is very welcome! If you have a suggestion or find a bug, please [open an issue](https://github.com/Safe-DS/Stdlib/issues/new/choose). If you have a question, please [use our discussion forum](https://github.com/orgs/Safe-DS/discussions).
-
-## Documentation
-
-You can find the full documentation [here](https://stdlib.safe-ds.com).
+Note that this library is still in development and not yet ready for production. Expect breaking changes in the future without a major version bump (while in the `0.y.z` version range). Feedback is very welcome, however! If you have a suggestion or find a bug, please [open an issue](https://github.com/Safe-DS/Stdlib/issues/new/choose). If you have a question, please [use our discussion forum][forum].
 
 ## Installation
 
@@ -30,3 +26,19 @@ Get the latest version from [PyPI](https://pypi.org/project/safe-ds):
 ```shell
 pip install safe-ds
 ```
+
+## Documentation
+
+You can find the full documentation [here](https://stdlib.safeds.com).
+
+## Contributing
+
+We welcome contributions from everyone. As a starting point, check the following resources:
+
+* [Setting up a development environment](https://stdlib.safeds.com/en/latest/development/environment/)
+* [Project guidelines](https://stdlib.safeds.com/en/latest/development/project_guidelines/)
+* [Contributing page](https://github.com/Safe-DS/Stdlib/contribute)
+
+If you need further help, please [use our discussion forum][forum].
+
+[forum]: https://github.com/orgs/Safe-DS/discussions

docs/development/code_review.md

@@ -0,0 +1,72 @@
+# Code review
+
+This document describes
+general guidelines for developers
+when reviewing a pull request (PR).
+
+## Verify that the PR solves the addressed issue
+
+### Understand the issue
+
+* Read the issue that was addressed by the PR and make sure you understand it
+* Read any discussions that occurred on the issue page
+
+### Check the PR
+
+* Check the PR for __completeness__: Was every point from the issue covered?
+* Check for __correctness__: Were the problems described in the issue solved in the intended way?
+* (For PRs that introduce new features:) Check the design - does it comply with our [project guidelines][guidelines-general]?
+* Check for potential bugs - edge cases, exceptions that may be raised in functions that were called etc.
+* Check the code style: Is it readable? Do variables have sensible names? Is it consistent to existing code? Is there a better / more elegant way to do certain things (e.g. [f-string](https://docs.python.org/3/tutorial/inputoutput.html#tut-f-strings) instead of manual string concatenation)?
+* Check any warnings reported by your IDE
+
+## Check the tests
+
+* Run the tests locally
+* Check if there are any warnings that are not caught by the test suite
+* Make sure the test cases are complete - do they cover all edge cases (e.g. empty tables)?
+* Make sure they comply to our [project guidelines][guidelines-tests] - are the tests parametrized and do all testcases have descriptive IDs?
+
+## Verify that the PR does not break existing code
+
+This is largely covered by the automated tests.
+However, you should always:
+
+* Make sure all tests actually ran through (pytest, linter, code coverage)
+* Make sure that the branch is up-to-date with the `main` branch, so you actually test the behaviour that will result once the feature branch is merged
+
+## Check the PR format
+
+* Check that the PR title starts with a fitting [type](https://github.com/Safe-DS/.github/blob/main/.github/CONTRIBUTING.md#types) (e.g. `feat`, `fix`, `docs`, ...)
+* Check that the changes introduced by the PR are documented in the PR message
+
+## Requesting changes
+
+If you found any issues with the reviewed PR,
+navigate to the `Files changed` tab in the PR page
+and click on the respective line
+to add your comments.
+
+For more details on specific review features,
+check out the [documentation on GitHub][github-review].
+
+## Finishing the review
+
+When done, finish your review
+by navigating to the `Files changed` tab
+and clicking the green `Review changes` button
+on the top right.
+
+If you found no issues,
+select the `Approve` option
+to approve the changes made by the PR.
+If you like, you can add a "LGTM" meme
+from [lgtm.party](https://lgtm.party/),
+preferably one with a cat image.
+
+If you found any problems,
+select `Request Changes` instead.
+
+[guidelines-general]: project_guidelines.md
+[guidelines-tests]: project_guidelines.md#tests
+[github-review]: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests