Skip to content

Commit

Permalink
add CONTRIBUTING and update README (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
rnetser authored Nov 6, 2024
1 parent 8ee9f44 commit c453546
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 1 deletion.
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# 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](README.md).

## Issues

### Create a new issue

If you find a problem with the code, [search if an issue already exists](https://github.com/opendatahub-io/opendatahub-tests/issues).
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](https://github.com/opendatahub-io/opendatahub-tests/issues/new/choose).

## 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](https://pre-commit.com/) package and installed

```bash
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](https://mypy-lang.org/)
48 changes: 47 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,48 @@
# opendatahub-tests
# TODO: update file

This repository contains ODH / Red Hat Openshift AI (RHOAI) tests.

## Contribute to opendatahub-tests
Please follow the [Contributing Guide](CONTRIBUTING.md)

# Getting started
## Installation

Install [uv](https://github.com/astral-sh/uv)

## Tests cluster

These tests can be executed against arbitrary cluster with ODH / RHOAI installed.

You can log in into such cluster via:

```bash
oc login -u user -p password
```

Or by setting `KUBECONFIG` variable:

```bash
KUBECONFIG=<kubeconfig file>
```

or by saving the kubeconfig file under `~/.kube/config`

## Running the tests
### Basic run of all tests

```bash
uv run pytest
```

### To overwrite a pytest config argument

```bash
uv run pytest --tc=<arg name>:<arg value>
```

For example:

```bash
uv run pytest --tc=ci_s3_bucket_name:my-bucket
```

0 comments on commit c453546

Please sign in to comment.