Skip to content

Commit 1a29752

Browse files
authored
docs: add good first issues section and dev setup guide (TruFoundation#39)
1 parent 2047d91 commit 1a29752

1 file changed

Lines changed: 34 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,38 @@ Thank you for your interest in contributing! This project follows an open and co
1515
- Use `black` for formatting and `ruff` for linting.
1616
- Keep logic simple and beginner-friendly.
1717

18-
## Issues
18+
## Good First Issues
19+
20+
If you are new to the TruFoundation codebase, a great way to get started is by tackling one of our beginner-friendly issues. These tasks are scoped to be low-risk, highly educational, and perfect for your first pull request.
21+
Currently, we recommend looking at:
22+
23+
- [Fix Sound Packaging Path in pyproject.toml](https://github.com/TruFoundation/TruShell/issues/31)
24+
- [Remove Unused typer Dependency from state.py](https://github.com/TruFoundation/TruShell/issues/33)
25+
- [Add csvview Alias for csv-view Command](https://github.com/TruFoundation/TruShell/issues/32)
26+
27+
## Development Environment Setup
1928

20-
If you find a bug or want to request a feature, please open an issue with a clear description and reproduction steps.
29+
To start contributing safely, you need to set up your local development environment. We strongly recommend isolating your workspace before installing dependencies.
30+
31+
1. **Clone the repository:**
32+
```bash
33+
git clone https://github.com/TruFoundation/TruShell.git
34+
cd TruShell
35+
```
36+
37+
2. **Create and activate a virtual environment:**
38+
```
39+
python3 -m venv .venv
40+
source .venv/bin/activate
41+
```
42+
3. **Install TruShell in editable mode:**
43+
44+
```
45+
pip install -e .
46+
```
47+
4. **Run the test suite:**
48+
```
49+
python -m pytest
50+
```
51+
## Issues
52+
If you find a bug or want to request a feature, please open an issue with a clear description and reproduction steps.

0 commit comments

Comments
 (0)