Skip to content

chore: add make lint/test entrypoints and fix repo URLs in CONTRIBUTING #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
michaelxu2288 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: add make lint/test entrypoints and fix repo URLs in CONTRIBUTING #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,28 @@ To set up your development environment for Agentex, please refer to the [README.
1. **Fork** the repository.
2. **Clone** your fork:
```bash
git clone https://github.com/<your-username>/agentex.git
cd agentex
git clone https://github.com/<your-username>/scale-agentex.git
cd scale-agentex
```
3. **Set the original repo as upstream** (recommended):
```bash
git remote add upstream https://github.com/scaleapi/agentex.git
git remote add upstream https://github.com/scaleapi/scale-agentex.git
```
4. **Create a new branch** for your feature or bugfix:
```bash
git checkout -b my-feature-or-bugfix
```
5. **Make your changes.**
Follow project coding style and conventions.
6. **Test your changes:**
6. **Test your changes** (backend; runs from the repo root or from `agentex/`):
```bash
make test
```
Run linter/formatter as required:
Run the linter/formatter checks as required:
```bash
make lint
```
For the developer UI, run `npm run lint`, `npm run typecheck`, and `npm test` inside `agentex-ui/`.
7. **Commit your changes** (see commit message guidelines below).
8. **Push** to your fork:
```bash
Expand Down
8 changes: 7 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# AgentEx Workspace Makefile
.PHONY: repo-setup help
.PHONY: repo-setup help lint test

@aringuyen3 aringuyen3 Oct 12, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we're currently hold off changes on this repo for a fix. will let you know once done


repo-setup: ## Setup development environment for the workspace
uv sync --group dev
uv run pre-commit install

lint: ## Run backend lint + format checks (delegates to agentex/)
$(MAKE) -C agentex lint

test: ## Run backend tests (delegates to agentex/; see agentex/Makefile for FILE/NAME/ARGS)
$(MAKE) -C agentex test

help: ## Show this help message
@echo "AgentEx Workspace Commands:"
@echo ""
Expand Down
8 changes: 8 additions & 0 deletions agentex/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ docker-build-with-docs: ## Build production Docker image with docs included
# Test Commands
#

lint: ## Check lint and formatting with ruff (the same checks as the pre-commit hooks)
uv run ruff check .
uv run ruff format --check .

lint-fix: ## Auto-fix lint errors and format with ruff
uv run ruff check . --fix
uv run ruff format .

test: ## Run tests (examples: make test FILE=path/to/test.py, make test NAME=pattern, make test ARGS="-v")
@uv run python scripts/run_tests.py \
$(if $(FILE),$(FILE)) \
Expand Down