chore(core): some cleanup (and messing about) before the real fun starts

[skyl]

PR Type

enhancement, documentation

---

Description

• Enhanced the DevContainer setup by modifying scripts and Dockerfile to use zsh as the default shell.
• Added a new README for the DevContainer, detailing features and usage.
• Simplified the docker-compose configuration by removing unnecessary environment variables and commands.
• Removed outdated GitHub configuration README and updated main README with correct links.
• Revised the TODO list with new tasks and completed items.

---

Changes walkthrough 📝

	Relevant files
Enhancement	entrypoint.sh Modify entrypoint script for DevContainer                                .devcontainer/entrypoint.sh Removed global Git configuration for safe directory. Commented out the infinite sleep command. +1/-2      setup.sh Update setup script with Git configuration                              .devcontainer/setup.sh Added a comment for random stuff. Commented out the zsh start command. Added global Git configuration for safe directory. +3/-1      Dockerfile Update Dockerfile to use zsh as default shell                        .devcontainer/Dockerfile Corrected capitalization of 'zsh'. Changed default shell for vscode to zsh. Added CMD to run zsh in interactive mode. +6/-1      docker-compose.yaml Simplify docker-compose configuration                                        .devcontainer/docker-compose.yaml Removed CI environment variable. Commented out entrypoint command. +2/-5
Documentation	README.md Add README for DevContainer setup                                                .devcontainer/README.md Added a new README for the DevContainer setup. Described features and usage instructions. +21/-0    README.md Remove GitHub configuration README                                              .github/README.md Removed GitHub-specific README file. +0/-5      README.md Update README with correct GitHub workflows link                  README.md Updated link to GitHub workflows documentation. +1/-1      TODO.md Revise TODO list with updated tasks                                            TODO.md Updated TODO list with new tasks and completed items. +5/-3

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

[github-actions]

PR Reviewer Guide 🔍

(Review updated until commit 4233a80)

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Clarity The addition of the comment 'random stuff ... hrm ...' does not provide clear context or purpose, which might confuse other developers or maintainers. Redundant Code The command 'RUN chsh -s /bin/zsh vscode' might be redundant if the container is already using zsh as its default shell, as indicated by other configurations.

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Security	Improve container security by running as a non-root user Specify a non-root user for running the container to enhance security. .devcontainer/Dockerfile [16] +USER vscode CMD ["sleep", "infinity"] Suggestion importance[1-10]: 9 Why: Running the container as a non-root user significantly enhances security by minimizing the risk of privilege escalation attacks. This is a crucial improvement for maintaining a secure container environment.	9
Enhancement	Prevent duplicate entries in .zshrc by checking before appending Replace the direct appending to .zshrc with a safer check to avoid duplicate entries. .devcontainer/setup.sh [5] -echo 'autoload -Uz add-zsh-hook; append_history() { fc -W }; add-zsh-hook precmd append_history; export HISTFILE=/home/vscode/.corpora.zsh_history/.zsh_history' >> ~/.zshrc +if ! grep -q 'append_history() { fc -W }' ~/.zshrc; then + echo 'autoload -Uz add-zsh-hook; append_history() { fc -W }; add-zsh-hook precmd append_history; export HISTFILE=/home/vscode/.corpora.zsh_history/.zsh_history' >> ~/.zshrc +fi Suggestion importance[1-10]: 8 Why: This suggestion effectively prevents duplicate entries in the .zshrc file, which enhances the robustness of the script by ensuring that the configuration is not redundantly appended, thus maintaining a cleaner configuration file.	8
Possible issue	Ensure the custom entrypoint script is utilized by uncommenting it Uncomment the entrypoint configuration to ensure the custom entrypoint script is used, which might be necessary for initializing the container environment correctly. .devcontainer/docker-compose.yaml [18] -# entrypoint: "./.devcontainer/entrypoint.sh" +entrypoint: "./.devcontainer/entrypoint.sh" Suggestion importance[1-10]: 7 Why: Uncommenting the entrypoint ensures that the custom script is executed, which might be necessary for proper initialization of the container environment. This can prevent potential issues related to environment setup.	7
Performance	Optimize Docker layer creation by combining commands into a single RUN instruction Combine the apt-get update, apt-get install, and cleanup commands into a single RUN instruction to reduce layers and optimize the build. .devcontainer/Dockerfile [4-6] -RUN apt-get update && apt-get install -y \ - postgresql-client zsh && \ - apt-get clean && rm -rf /var/lib/apt/lists/* +RUN apt-get update && apt-get install -y postgresql-client zsh && apt-get clean && rm -rf /var/lib/apt/lists/* Suggestion importance[1-10]: 5 Why: While combining the commands into a single RUN instruction can slightly optimize the Docker image by reducing the number of layers, the impact is relatively minor in this context, as the existing code already combines related operations efficiently.	5

[skyl]

/help "what do you think of the PR now?"

[github-actions]

Question:

what do you think of the pr now?

Answer:

To provide feedback on the pull request, you can use the /review command. This tool scans the PR code changes and generates a list of feedback aiming to aid the reviewing process. It can be triggered automatically or invoked manually by commenting /review on any PR. For more details on how to use this tool, please refer to the documentation.

Relevant Sources:

• https://qodo-merge-docs.qodo.ai/tools/review#overview
• https://qodo-merge-docs.qodo.ai/index#qodo-merge-features

[skyl]

/review

[skyl]

/describe

[skyl]

/help

[github-actions]

Persistent review updated to latest commit 4233a80

[github-actions]

Persistent review updated to latest commit 4233a80

[github-actions]

PR Description updated to latest commit (4233a80)

[github-actions]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
Security	Improve container security by running as a non-root user Specify a non-root user for running the container to enhance security. .devcontainer/Dockerfile [16] +USER vscode CMD ["sleep", "infinity"] Suggestion importance[1-10]: 9 Why: Running the container as a non-root user significantly enhances security by minimizing the risk of privilege escalation attacks. This is a crucial improvement for maintaining a secure container environment.	9
Enhancement	Prevent duplicate entries in .zshrc by checking before appending Replace the direct appending to .zshrc with a safer check to avoid duplicate entries. .devcontainer/setup.sh [5] -echo 'autoload -Uz add-zsh-hook; append_history() { fc -W }; add-zsh-hook precmd append_history; export HISTFILE=/home/vscode/.corpora.zsh_history/.zsh_history' >> ~/.zshrc +if ! grep -q 'append_history() { fc -W }' ~/.zshrc; then + echo 'autoload -Uz add-zsh-hook; append_history() { fc -W }; add-zsh-hook precmd append_history; export HISTFILE=/home/vscode/.corpora.zsh_history/.zsh_history' >> ~/.zshrc +fi Suggestion importance[1-10]: 8 Why: This suggestion effectively prevents duplicate entries in the .zshrc file, which enhances the robustness of the script by ensuring that the configuration is not redundantly appended, thus maintaining a cleaner configuration file.	8
Possible issue	Ensure the custom entrypoint script is utilized by uncommenting it Uncomment the entrypoint configuration to ensure the custom entrypoint script is used, which might be necessary for initializing the container environment correctly. .devcontainer/docker-compose.yaml [18] -# entrypoint: "./.devcontainer/entrypoint.sh" +entrypoint: "./.devcontainer/entrypoint.sh" Suggestion importance[1-10]: 7 Why: Uncommenting the entrypoint ensures that the custom script is executed, which might be necessary for proper initialization of the container environment. This can prevent potential issues related to environment setup.	7
Performance	Optimize Docker layer creation by combining commands into a single RUN instruction Combine the apt-get update, apt-get install, and cleanup commands into a single RUN instruction to reduce layers and optimize the build. .devcontainer/Dockerfile [4-6] -RUN apt-get update && apt-get install -y \ - postgresql-client zsh && \ - apt-get clean && rm -rf /var/lib/apt/lists/* +RUN apt-get update && apt-get install -y postgresql-client zsh && apt-get clean && rm -rf /var/lib/apt/lists/* Suggestion importance[1-10]: 5 Why: While combining the commands into a single RUN instruction can slightly optimize the Docker image by reducing the number of layers, the impact is relatively minor in this context, as the existing code already combines related operations efficiently.	5

[github-actions]

PR Agent Walkthrough 🤖

Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more.

Here is a list of tools you can use to interact with the PR Agent:

Tool	Description	Trigger Interactively 💎
DESCRIBE	Generates PR description - title, type, summary, code walkthrough and labels	Run
REVIEW	Adjustable feedback about the PR, possible issues, security concerns, review effort and more	Run
IMPROVE	Code suggestions for improving the PR	Run
UPDATE CHANGELOG	Automatically updates the changelog	Run
ADD DOCS 💎	Generates documentation to methods/functions/classes that changed in the PR	Run
TEST 💎	Generates unit tests for a specific component, based on the PR code change	Run
IMPROVE COMPONENT 💎	Code suggestions for a specific component that changed in the PR	Run
ANALYZE 💎	Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component	Run
ASK	Answering free-text questions about the PR	[*]
GENERATE CUSTOM LABELS 💎	Generates custom labels for the PR, based on specific guidelines defined by the user	[*]
CI FEEDBACK 💎	Generates feedback and analysis for a failed CI job	[*]
CUSTOM PROMPT 💎	Generates custom suggestions for improving the PR code, derived only from a specific guidelines prompt defined by the user	[*]
SIMILAR ISSUE	Automatically retrieves and presents similar issues	[*]

(1) Note that each tool be triggered automatically when a new PR is opened, or called manually by commenting on a PR.

(2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the /ask tool, you need to comment on a PR: /ask "<question content>". See the relevant documentation for each tool for more details.