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

feat: ignore people names in NOTE #13

Merged
merged 1 commit into from
Dec 5, 2024

Conversation

HansRobo
Copy link
Member

@HansRobo HansRobo commented Dec 5, 2024

Description

ignore people names in NOTE(<name>) comments

Related links

Parent Issue/PR:

None

Links to the definitions of the words added:

A widely seen way of writing comments with names attached.
https://github.com/search?q=%22%2F%2F+NOTE%28%22+language%3AC%2B%2B&type=code&l=C%2B%2B
Compared to normal comments, this is useful because it makes it clear who is responsible for the comment.

Here, I am not adding this pattern because I want to ignore NOTE comments, but to ignore <name> in NOTE(<name>).

Notes for reviewers

Some people using NOTE(<name>) for taking notes with their own names.
https://github.com/search?q=org%3Aautowarefoundation+NOTE%28&type=code

my dictionary maintaining policy for personal names

When I was maintaining tier4/autoware-spell-check-dict, my maintaining policy for people name was as follows:

  • Generally, I do not add personal names to the dictionary
    • I ignore patterns in which people names appear, making the dictionary robust to new contributors, like this PR.
  • Contributor names that are not matched by a pattern are added to the "people_names" dictionary in tier4/cspell-dicts.
  • Names that only appear in a few places, such as the author names of papers referenced in the implementation, can be ignored on the spot by using cspell: ignore <name> in the code.

Copy link

github-actions bot commented Dec 5, 2024

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

@HansRobo
Copy link
Member Author

HansRobo commented Dec 5, 2024

Thank you!

@HansRobo HansRobo merged commit 45eac18 into autowarefoundation:main Dec 5, 2024
6 checks passed
@HansRobo HansRobo deleted the HansRobo-patch-1 branch December 5, 2024 02:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants