Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves developer onboarding for the stack repository by adding contributor/security documentation, introducing an interactive local setup script, and making a few small configuration adjustments to development/production Compose and dargstack behavior.
Changes:
- Added onboarding and policy documentation (
AGENTS.md,CONTRIBUTING.md,SECURITY.md) and refreshedREADME.mdquickstart guidance. - Added
scripts/setup.shto automate cloning related repos and runningdargstack build/deployfor local fullstack setup. - Tweaked configuration: enable volume-removal prompting in
dargstack.yaml, adjust compose user configuration, and tighten env var name validation in Zammad’s entrypoint.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/setup.sh |
New interactive bootstrap script for cloning/building/deploying local dev stack. |
CONTRIBUTING.md |
New contributor guide describing setup modes and workflow guidelines. |
README.md |
New/updated project overview and quickstart pointing to the setup script and docs. |
AGENTS.md |
Added repository instructions (style, structure, dargstack workflow). |
SECURITY.md |
Added responsible disclosure policy. |
dargstack.yaml |
Enables prompting to remove volumes before deploy in development. |
src/development/zammad/configurations/docker-entrypoint.sh |
Tightened env var-name validation for env-file loading. |
src/development/vibetype/compose.yaml |
Removes explicit container user for vibetype dev service. |
src/production/vibetype/compose.yaml |
Removes the production override that pruned the user field. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
503ab1b to
88c290c
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces major improvements to project documentation and developer onboarding, along with minor configuration and code adjustments. The most significant changes are the addition of comprehensive documentation files, a new automated setup script for local development, and updates to configuration files for improved usability and correctness.
Documentation and Onboarding Improvements:
AGENTS.mdfile outlining project structure, documentation map, code style, git workflow, and deployment practices for contributors.CONTRIBUTING.mdwith step-by-step development setup instructions (both automated and manual), repository structure, and contribution guidelines.SECURITY.mdfile describing the responsible disclosure policy for security vulnerabilities in Vibetype.README.mdto include CI badge, project overview, and clearer quickstart instructions, referencing the new documentation.Developer Experience Enhancements:
scripts/setup.sh, an interactive Bash script that automates local fullstack environment setup, including prerequisites check, repository cloning, and initial build/deploy steps.Configuration and Code Adjustments:
dargstack.yamlto prompt for volume removal before deploying in development by settingremove: true.user: node:nodefromsrc/development/vibetype/compose.yamland pruned the user in the production compose, likely to rely on image defaults or external configuration.src/development/zammad/configurations/docker-entrypoint.shto require variable names to start with a letter or underscore, and simplified value assignment.