Skip to content

Commit

Permalink
dev: add a contributing doc to the project (#45)
Browse files Browse the repository at this point in the history
  • Loading branch information
hussein-awala authored May 3, 2024
1 parent edf663b commit 20d1485
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Contributing Guidelines

We welcome contributions from the community and are happy to have them.
Please follow this guide when logging issues or making changes.

## Installation

To install the package, you can check [this documentation](README.md#installation).

## Testing

We use `pytest` for testing. To run the tests, you can use the following command:

```bash
pytest
```

## Reporting a bug

If you find a bug in this project, you can report it by opening an issue via this
[link](https://github.com/hussein-awala/spark-on-k8s/issues/new) and providing all the
information can help reproduce it.
If you already have a fix for the bug, you can skip creating an issue and submit a PR to fix it.

**Warning**: if the bug is a security vulnerability, please follow
[this documentation](SECURITY.md#reporting-a-vulnerability) to report it.

## Questions

If you have any question, a new idea, or anything to discuss, you can start a new discussion
via this [link](https://github.com/hussein-awala/spark-on-k8s/discussions/new/choose).

0 comments on commit 20d1485

Please sign in to comment.