-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
dev: add a contributing doc to the project (#45)
- Loading branch information
1 parent
edf663b
commit 20d1485
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |