CONTRIBUTING.md

Welcome to opendatahub-tests contributing guide

Thank you for contributing to our project!

New contributor guide

To get an overview of the project, read the README.

Issues

Create a new issue

If you find a problem with the code, search if an issue already exists.
If you open a pull request to fix the problem, an issue will ba automatically created.
If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Pull requests

To contribute code to the project:

• Fork the project and work on your forked repository
• Before submitting a new pull request, make sure you have pre-commit package and installed

pre-commit install

• When submitting a pull request, make sure to fill all the required, relevant fields for your PR.
  Make sure the title is descriptive and short.

General

• Add typing to new code; typing is enforced using mypy
  • Rules are defined in our pyproject.toml file

If you use Visual Studio Code as your IDE, we recommend using the Mypy Type Checker extension. After installing it, make sure to update the Mypy-type-checkers: Args setting to "mypy-type-checker.args" = ["--config-file=pyproject.toml"].