Skip to content

Commit

Permalink
add contributing doc page.
Browse files Browse the repository at this point in the history
  • Loading branch information
Sheeproid committed Dec 8, 2024
1 parent 9afa83f commit e66dc8f
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Contributing

## Before you get started

### Code of Conduct

Please make sure to read and observe our Code of Conduct.

### Install requirements
- Python `3.11`
- poetry `1.8.4` & up
- A LLM API key is required to use and test HolmesGPT
- OpenAI's `gpt4-o` is recommended.
- For details see [Getting an API Key](https://github.com/robusta-dev/holmesgpt?tab=readme-ov-file#getting-an-api-key).

## Reporting bugs

We encourage those interested to contribute code and also appreciate when issues are reported.

- Create a new issue and label is as `bug`
- Clearly state how to reproduce the bug:
- Which LLM you've used
- Which steps are required to reproduce
- As LLMs answers may differ between runs - Does it always reproduce, or occasionally?


## Contributing Code

- Fork the repository and clone it locally.
- Create a new branch and make your changes
- Add or update tests to ensure your changes are covered.
- Run `pytest` to verify all tests pass.
- Keep pull requests small and focused. if you have multiple changes, open a PR for each.
- Create a pull request back to the upstream repository.
- Wait for a review and address any comments

0 comments on commit e66dc8f

Please sign in to comment.