Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

Update CONTRIBUTING.md file with bounty board

Isaac Miller8e6b7c4c2010
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f50a6d663..9dc457fad 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,14 +1,25 @@
-# Setting-up
+# Contibuting
-## Crete new envirinment
+## Finding Issues
-```
+### Bounty Board
+
+The bounty board will have various features, issues, and requests that are up for grabs.
+
+See the spreadsheet [here](https://docs.google.com/spreadsheets/d/1psHSfFXENAxhQTd5veKRzKydVubD2Ov62aKQHiYC-CQ/edit?usp=sharing) for the current bounties.
+
+
+## Setting-up
+
+### Create new environment
+
+```bash
conda create --name dspy python=3.11
```
or
-```
+```bash
python3 -m venv dspy
```
@@ -16,28 +27,28 @@ python3 -m venv dspy
Before using pre-commit hook you need to install it in your python environment.
-```
+```bash
conda install -c conda-forge pre-commit
```
go to the root folder and then activate it as follows (it will first download all required dependencies):
-```
+```bash
pre-commit install
```
> Pre-commit hooks will attept to fix all your files and so you will need to (add + commit) them once the fixes are done !
-#### Optional:
+### Optional
Generally the pre-commit will run automatically before each of your commit,
but you can also manually trigger it, as follows:
-```
+```bash
pre-commit run --all-files
```
-## Commit Message format:
+## Commit Message format
Commit message format must be respected, with the followint regex: