Skip to content

Commit 8e6b7c4

Browse files
committed
Update CONTRIBUTING.md file with bounty board
1 parent 3bb46ee commit 8e6b7c4

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

CONTRIBUTING.md

+20-9
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,54 @@
1-
# Setting-up
1+
# Contibuting
22

3-
## Crete new envirinment
3+
## Finding Issues
44

5-
```
5+
### Bounty Board
6+
7+
The bounty board will have various features, issues, and requests that are up for grabs.
8+
9+
See the spreadsheet [here](https://docs.google.com/spreadsheets/d/1psHSfFXENAxhQTd5veKRzKydVubD2Ov62aKQHiYC-CQ/edit?usp=sharing) for the current bounties.
10+
11+
12+
## Setting-up
13+
14+
### Create new environment
15+
16+
```bash
617
conda create --name dspy python=3.11
718
```
819

920
or
1021

11-
```
22+
```bash
1223
python3 -m venv dspy
1324
```
1425

1526
## Pre-commit hook
1627

1728
Before using pre-commit hook you need to install it in your python environment.
1829

19-
```
30+
```bash
2031
conda install -c conda-forge pre-commit
2132
```
2233

2334
go to the root folder and then activate it as follows (it will first download all required dependencies):
2435

25-
```
36+
```bash
2637
pre-commit install
2738
```
2839

2940
> Pre-commit hooks will attept to fix all your files and so you will need to (add + commit) them once the fixes are done !
3041
31-
#### Optional:
42+
### Optional
3243

3344
Generally the pre-commit will run automatically before each of your commit,
3445
but you can also manually trigger it, as follows:
3546

36-
```
47+
```bash
3748
pre-commit run --all-files
3849
```
3950

40-
## Commit Message format:
51+
## Commit Message format
4152

4253
Commit message format must be respected, with the followint regex:
4354

0 commit comments

Comments
 (0)