Revisit development rules for more efficiency about autoware-documentation HOT 7 OPEN

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.