Comments (7)
I think we need rules to clarify the interface for the following reasons.
- It's often difficult to know what parameters/topic the node has because the interface definitions (e.g. create_subscription) are scattered in the code.
- There is no way to know which topics are public or private in the launch file.
- A mixture of the default values in the source code and the remap values in the launch file.
from autoware-documentation.
Not a strict rule, but there's a guideline to write good code, called Object Calisthenics. This is a pretty strict guideline, so it is not necessary to precisely follow, but it helps to write testable, reusable, and extensible code.
In that case, it's better to link the document as a reference.
Regarding some important techniques can be picked up and be written in our guidelines. (If there are no license issues.)
Anyway, whatever we adopt, it would be better to have some tips or guidelines for writing good code other than coding rules.
Yes, of course. I'm preparing it.
from autoware-documentation.
Not a strict rule, but there's a guideline to write good code, called Object Calisthenics. This is a pretty strict guideline, so it is not necessary to precisely follow, but it helps to write testable, reusable, and extensible code.
from autoware-documentation.
Anyway, whatever we adopt, it would be better to have some tips or guidelines for writing good code other than coding rules.
By accumulating knowledge and tips and publishing them, we can improve our product quality and contribute to open source communities.
from autoware-documentation.
This pull request has been automatically marked as stale because it has not had recent activity.
from autoware-documentation.
I think I can write some more documents this month.
from autoware-documentation.
This pull request has been automatically marked as stale because it has not had recent activity.
from autoware-documentation.
Related Issues (20)
- Add documentation for map interface HOT 1
- DevOps Dojo: ROS Node Configuration - JSON Schema to MD-Table for Web Documentation HOT 6
- DevOps Dojo: ROS Node Configuration - Update Parameter Contribution Guidelines HOT 2
- Establish and document the versioning system for the autoware_msgs HOT 2
- Add documentation for Creating vehicle and sensor description HOT 2
- Add documentation on how to add a new localization node in autoware HOT 1
- Fill the documentation of "Creating vehicle interface for ackerman kinematic model"
- The link to the Autoware concepts documentation page may be broken. HOT 2
- Add documentation on how to guide autoware meta-repository
- "Behavior Planner" calculates "path", not "trajectory".
- Broken Links Issue Tracking HOT 4
- Update Autoware Integration Document HOT 1
- Update DDS isolation instructions for shared networks in Autoware HOT 5
- Add documentation how to train traffic light fine detector model HOT 2
- Update docker installation documentation
- Add docs for guiding the developers on finding, diagnosing, and fixing scenarios in Autoware HOT 3
- Update contributors guide to explain the default settings for PR branch created from a fork
- Update the sample rosbag for Rosbag replay simulation HOT 1
- Fix autoware_pose_covariance_modifier_node flowchart HOT 1
- Create a rosbag from anonymized dataset images HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from autoware-documentation.