quality/testdays-web
6
0
Fork 0
Code Issues 9 Pull requests 1 Projects Releases Packages Wiki Activity Actions

Update local execution developer documentation #136

Merged
jgroman merged 1 commit from docs/123-update-local-execution-info into develop 2026-08-06 08:51:50 +00:00
Conversation 4 Commits 1 Files changed 2 +100 -56
jgroman commented 2026-07-31 11:06:07 +00:00
Owner
Copy link

Developer documentation is updated to reflect current recommended way to setup local development environment.
Added check for required tools in Makefile.

Fixes #123

Assisted-by: Claude Code

Developer documentation is updated to reflect current recommended way to setup local development environment. Added check for required tools in Makefile. Fixes #123 Assisted-by: Claude Code
jgroman self-assigned this 2026-07-31 11:06:07 +00:00
Update developer documentation
All checks were successful
Run tests / test (pull_request) Successful in 32s
Details
e563f21b8e 
Developer documentation is updated to reflect current recommended way to setup local development environment.
Added check for required tools in Makefile.

Fixes #123

Assisted-by: Claude Code
jgroman requested review from kparal 2026-07-31 11:09:36 +00:00
jgroman commented 2026-07-31 11:09:46 +00:00
Author
Owner
Copy link

Ready for review

Ready for review
adamwill reviewed 2026-07-31 16:14:06 +00:00
Makefile Outdated
@ -40,0 +40,4 @@
# Skipped inside devcontainers where the DB is managed by compose directly.
_check_deps:
ifndef IS_DEVCONTAINER
@command -v $(firstword $(PODMAN_CMD)) >/dev/null 2>&1 \
adamwill commented 2026-07-31 16:14:06 +00:00
Owner
Copy link

what is going on here? what's the @command for? why are we calling firstword on PODMAN_CMD? won't that just check that flatpak-spawn runs, but not that it can run podman, if we're in a toolbox?

what is going on here? what's the `@command` for? why are we calling `firstword` on `PODMAN_CMD`? won't that just check that `flatpak-spawn` runs, but not that it can run podman, if we're in a toolbox?
jgroman commented 2026-08-03 09:12:23 +00:00
Author
Owner
Copy link

This is a good point! One could argue that inside toolbox podman is very likely available but yeah - this check was broken regardless. Fixed.

This is a good point! One could argue that inside toolbox podman is very likely available but yeah - this check was broken regardless. Fixed.
jgroman marked this conversation as resolved
adamwill reviewed 2026-07-31 16:20:22 +00:00
adamwill left a comment
Copy link

Don't have time to go through the rest and check it's accurate RN, sorry...if kparal doesn't I will later.

Don't have time to go through the rest and check it's accurate RN, sorry...if kparal doesn't I will later.
Fix review finding: podman detection inside toolbox
All checks were successful
Run tests / test (pull_request) Successful in 57s
Details
f7395be6b7
adamwill approved these changes 2026-08-05 15:25:02 +00:00
adamwill left a comment
Copy link

OK, this looks good to me. Thanks.

OK, this looks good to me. Thanks.
jgroman force-pushed docs/123-update-local-execution-info from f7395be6b7
All checks were successful
Run tests / test (pull_request) Successful in 57s
Details
to 753e2d8000
All checks were successful
Run tests / test (pull_request) Successful in 33s
Details
2026-08-06 08:32:46 +00:00 Compare
jgroman force-pushed docs/123-update-local-execution-info from 753e2d8000
All checks were successful
Run tests / test (pull_request) Successful in 33s
Details
to 9aa326cb70
All checks were successful
Run tests / test (pull_request) Successful in 33s
Details
2026-08-06 08:48:22 +00:00 Compare
jgroman merged commit 9aa326cb70 into develop 2026-08-06 08:51:50 +00:00
jgroman deleted branch docs/123-update-local-execution-info 2026-08-06 08:51:50 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
kparal
adamwill
Labels
Clear labels   
Closed As
Duplicate
 Closed with the reason of Duplicate

  
Closed As
Fixed
 Closed with the reason of Fixed

  
Closed As
Invalid
 Closed with the reason of Invalid

  
easyfix

   
enhancement
  
ai-review-please
Request AI review for a pull request

  
Backlog Status
Needs Review
 Work items that have been created or updated but need review, refinement, or approval before they can be considered ready for sprint planning.

  
Backlog Status
Ready
 Work items that have been reviewed, refined, and are ready to be committed to a sprint. These items have clear requirements and can be worked on immediately when capacity is available.

  
chore
Work that needs to be done but doesn't add new functionality or fix bugs. Maintenance tasks that keep the system running smoothly and the codebase clean.

  
documentation
Work focused on creating, updating, or improving documentation for users, developers, or system administrators.

  
points
01
 A task that is simple, small, and has very little uncertainty. It should be easy enough for any team member to pick up and complete quickly, without a lot of discussion or research.

  
points
02
 This is a task that is slightly more complex or larger than a "1." It might involve two or three simple steps, but the outcome is still very clear and there's little uncertainty.

  
points
03
 Medium-sized task with some noticeable complexity. It might require a bit more thought or collaboration. The steps are well-defined, but it's not a trivial change.

  
points
05
 A significant piece of work. It has more complexity and a higher degree of uncertainty than smaller tasks. It might require some research, a design discussion, or collaboration across multiple teams.

  
points
08
 Complex task with a lot of uncertainty. It's often the largest size that a team will consider for a single sprint. It likely requires a detailed breakdown and multiple team members to complete.

  
points
13
 Any task that feels like it's a "13" or more is considered an Epic. These are too large and uncertain to be worked on in a single sprint and should be broken down.

  
pr2jira
Sync this pull request to Jira for Agility tracking. Only use for PRs without a corresponding ticket.

  
Priority
Critical
 This is for work that is urgent and of critical importance and so and must be addressed immediately with a higher priority than all other work, even if not originally planned for the current sprint.

  
Priority
High
 This is for work that is critical and needs to be addressed in the next sprint. It's often for urgent bugs, important features, or a major piece of technical debt that is blocking other work.

  
Priority
Low
 This is for work that is good to do but not urgent. It's a candidate for being worked on when there's extra time or when it rises in importance. It can stay in the backlog for a longer period.

  
Priority
Medium
 This is for important work that should be done soon, but isn't as urgent as a high-priority item. It will likely be considered for the next 1-2 sprints.

  
Sprint Status
Blocked
 Work items that cannot progress due to external dependencies, blockers, or issues that need resolution.

  
Sprint Status
Done
 Work items that have been completed, reviewed, and integrated. No further work is needed within the current sprint.

  
Sprint Status
In Progress
 Work items currently being worked on by a team member. Active development, research, or implementation is happening.

  
Sprint Status
Review
 Work items that are complete but need review, testing, or approval before being marked as done.

  
Sprint Status
To Do
 Work items that are committed to the sprint but haven't been started yet. These items are ready to be picked up by team members.

  
Technical Debt
Work that addresses shortcuts, workarounds, or suboptimal implementations that were done previously to meet deadlines. These items improve code quality, maintainability, or performance without adding new features.

  
Work Item
Bug
 Issues where the system is not working as intended or designed. Bugs represent deviations from expected behavior.

  
Work Item
Epic
 Large initiatives that are broken down into multiple smaller work items (user stories, tasks, bugs). Epics represent significant features or projects that span multiple sprints.

  
Work Item
Spike
 Time-boxed research, investigation, or proof-of-concept work to reduce uncertainty or explore solutions. Spikes help inform future development decisions.

  
Work Item
Task
 Used to break down larger user stories into smaller, manageable implementation pieces. They focus on the specific technical steps needed to deliver the user story's value.

  
Work Item
User Story
 User-facing features or functionality that can be framed from a user perspective, describing what someone wants to accomplish and why.

No labels
Closed As
Duplicate
Closed As
Fixed
Closed As
Invalid
easyfix
enhancement
ai-review-please
Backlog Status
Needs Review
Backlog Status
Ready
chore
documentation
points
01
points
02
points
03
points
05
points
08
points
13
pr2jira
Priority
Critical
Priority
High
Priority
Low
Priority
Medium
Sprint Status
Blocked
Sprint Status
Done
Sprint Status
In Progress
Sprint Status
Review
Sprint Status
To Do
Technical Debt
Work Item
Bug
Work Item
Epic
Work Item
Spike
Work Item
Task
Work Item
User Story
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
jgroman
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks
#123 Update developer documentation for local execution
quality/testdays-web
Reference
quality/testdays-web!136
No description provided.