una-auxme / paf

MIT License
6 stars 0 forks source link

315 feature remove pycharm from project #318

Closed JulianTrommer closed 3 days ago

JulianTrommer commented 3 days ago

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

Does this PR introduce a breaking change?

e.g. is old functionality not usable anymore

Most important changes

Which files functionalities are most important in this PR. On which part should the reviewer be focussed on?

Checklist:

Summary by CodeRabbit

coderabbitai[bot] commented 3 days ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

The pull request introduces several changes across multiple documents and configuration files. Key modifications include updates to the .markdownlint.yaml for markdown linting rules, enhancements to the Dockerfile for the CARLA ROS bridge environment, and a comprehensive overhaul of coding style guidelines in coding_style.md. Additionally, various markdown documents have been reformatted for consistency, including updates to bullet point styles and the addition of new sections in several research documents. Overall, the changes aim to improve readability, maintainability, and consistency across the project.

Changes

File Path Change Summary
.markdownlint.yaml - Rule MD004 style changed from "consistent" to "dash".
- Rule MD051 set to false.
- Corrected indentation for tables under MD013.
build/docker/agent/Dockerfile - Set base image to osrf/ros:noetic-desktop-full-focal.
- Streamlined installation of dependencies.
- Added CUDA installation details and environment variable settings.
- Created non-root user and catkin workspace.
doc/02_development/04_coding_style.md - Updated coding style guidelines for Python, including indentation, line breaks, naming conventions, and comments.
doc/02_development/06_pycharm_setup.md - File deleted; previously contained setup instructions for PyCharm.
doc/02_development/08_project_management.md - Clarified project management process with detailed instructions for GitHub usage.
doc/02_development/templates/template_class.py - Removed shebang, organized imports, updated docstring formats for methods, and removed test_function5.
doc/02_development/templates/template_wiki_page.md - Removed TOC generation instructions for PyCharm, reformatted list markers.
doc/02_development/templates/template_wiki_page_empty.md - Minor formatting changes in the TOC and prerequisites section.
doc/03_research/01_acting/*.md - Various formatting updates, including bullet point styles and section organization for improved readability.
doc/03_research/02_perception/*.md - Similar formatting updates as above, including TOC and list item styles.
doc/03_research/03_planning/*.md - Enhanced structure and formatting in multiple documents, including TOC updates and clearer list presentations.
doc/03_research/04_requirements/*.md - Formatting changes for consistency in list styles and section titles.
doc/06_perception/*.md - Formatting adjustments and clarifications regarding the use of components and dataset structures.

Possibly related PRs

🐰 Hopping through the code, with changes so bright,
Markdown rules and Docker files, all polished just right.
From coding styles to templates, we’ve tidied the way,
With clarity and structure, let’s code and play!
A leap into the future, with every little fix,
Our project shines anew, with these delightful tricks! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 3 days ago

Simulation results

Metric Value
Avg. driving score 8e-06
Avg. route completion 38.845
Avg. infraction penalty 0.0
Collisions with pedestrians 1.15
Collisions with vehicles 18.229
Collisions with layout 3.941
Red lights infractions 0.0
Stop sign infractions 0.328
Off-road infractions 0.167
Route deviations 0.164
Route timeouts 0.0
Agent blocked 0.164
Yield emergency vehicles infractions 0.0
Scenario timeouts 0.164
Min speed infractions 0.164