docs: clarify Windows environment expectations and WSL recommendation

This commit is contained in:
ayush123-bit
2026-01-26 22:31:20 +05:30
parent 02330653ee
commit 6d7d472792
2 changed files with 26 additions and 2 deletions
+17 -1
View File
@@ -6,6 +6,10 @@ Thank you for your interest in contributing to the Aden Agent Framework! This do
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
## Contributor License Agreement
By submitting a Pull Request, you agree that your contributions will be licensed under the Aden Agent Framework license.
## Issue Assignment Policy
To prevent duplicate work and respect contributors' time, we require issue assignment before submitting PRs.
@@ -55,6 +59,12 @@ python -c "import framework; import aden_tools; print('✓ Setup complete')"
./quickstart.sh
```
> **Windows Users:**
> If you are on native Windows, it is recommended to use **WSL (Windows Subsystem for Linux)**.
> Alternatively, make sure to run PowerShell or Git Bash with Python 3.11+ installed, and disable "App Execution Aliases" in Windows settings.
> **Tip:** Installing Claude Code skills is optional for running existing agents, but required if you plan to **build new agents**.
## Commit Convention
We follow [Conventional Commits](https://www.conventionalcommits.org/):
@@ -119,6 +129,12 @@ feat(component): add new feature description
## Testing
> **Note:** When testing agents in `exports/`, always set PYTHONPATH:
>
> ```bash
> PYTHONPATH=core:exports python -m agent_name test
> ```
```bash
# Run all tests for the framework
cd core && python -m pytest
@@ -134,4 +150,4 @@ PYTHONPATH=core:exports python -m agent_name test
Feel free to open an issue for questions or join our [Discord community](https://discord.com/invite/MXE49hrKDk).
Thank you for contributing!
Thank you for contributing!