Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revisit development rules for more efficiency #6

Open
12 tasks
kenji-miyake opened this issue Dec 21, 2021 · 7 comments
Open
12 tasks

Revisit development rules for more efficiency #6

kenji-miyake opened this issue Dec 21, 2021 · 7 comments
Labels
status:stale Inactive or outdated issues. (auto-assigned)

Comments

@kenji-miyake
Copy link
Contributor

kenji-miyake commented Dec 21, 2021

We'll send PRs for each item and discuss them in the PRs.

@isamu-takagi
Copy link
Contributor

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.

@IshitaTakeshi
Copy link
Contributor

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.

@IshitaTakeshi
Copy link
Contributor

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.

@kenji-miyake
Copy link
Contributor Author

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.

@stale
Copy link

stale bot commented May 5, 2022

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the status:stale Inactive or outdated issues. (auto-assigned) label May 5, 2022
@kenji-miyake
Copy link
Contributor Author

I think I can write some more documents this month.

@stale stale bot removed the status:stale Inactive or outdated issues. (auto-assigned) label May 5, 2022
@stale
Copy link

stale bot commented Jul 4, 2022

This pull request has been automatically marked as stale because it has not had recent activity.

@stale stale bot added the status:stale Inactive or outdated issues. (auto-assigned) label Jul 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:stale Inactive or outdated issues. (auto-assigned)
Projects
None yet
Development

No branches or pull requests

3 participants