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

Fix #2175, Apply consistent Event ID names to common events #2176

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thnkslprpt
Copy link
Contributor

@thnkslprpt thnkslprpt commented Oct 21, 2022

Checklist

Describe the contribution

Testing performed
Only GitHub CI actions.

Expected behavior changes
No impact on code behavior (no logic changes).
Consistent Event ID names for the events which are common to all/most cFS components and apps will improve consistency and ease make code review/debugging easier.

Contributor Info
Avi Weiss @thnkslprpt

@dzbaker dzbaker requested a review from jphickey October 27, 2022 19:04
Copy link
Contributor

@jphickey jphickey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a good improvement on the event names, we should consider adding a paragraph to https://github.com/nasa/cFE/blob/main/docs/cFS_IdentifierNamingConvention.md that focuses on event names to document how the name should be constructed.

@thnkslprpt
Copy link
Contributor Author

I think this is a good improvement on the event names, we should consider adding a paragraph to https://github.com/nasa/cFE/blob/main/docs/cFS_IdentifierNamingConvention.md that focuses on event names to document how the name should be constructed.

Yes good point - I will draft something up today and add it to that markdown doc.

@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch from 7fd6661 to b306ca5 Compare October 31, 2022 22:56
@thnkslprpt
Copy link
Contributor Author

I think this is a good improvement on the event names, we should consider adding a paragraph to https://github.com/nasa/cFE/blob/main/docs/cFS_IdentifierNamingConvention.md that focuses on event names to document how the name should be constructed.

I added the following section to the naming convention doc and squashed all the commits together now for merging.
Screenshot 2022-11-01 08 52 00

@thnkslprpt thnkslprpt requested a review from jphickey November 15, 2022 11:27
@thnkslprpt
Copy link
Contributor Author

thnkslprpt commented Nov 15, 2022

I think this is a good improvement on the event names, we should consider adding a paragraph to https://github.com/nasa/cFE/blob/main/docs/cFS_IdentifierNamingConvention.md that focuses on event names to document how the name should be constructed.

@jphickey Joe - just making sure you're OK with the section I added to the naming convention doc.
Re-requested review as I added that commit here (and squashed it) after your original approval.

Removed the paragraph 8. that I added (see https://github.com/nasa/cFE/compare/4885bd1aacb0506e7784ac14931c09a48670fd9e..4820e166ef0bb0ebe7c074a0f8dbd0e2eeb6148f#) as something similar is already now present since #2254.

@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch 2 times, most recently from 21e0856 to 9a39e73 Compare March 12, 2023 01:03
@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch 2 times, most recently from d3f4a25 to 4885bd1 Compare March 31, 2023 02:53
@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch from 4885bd1 to 4820e16 Compare April 14, 2023 00:39
@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch from 4820e16 to 6dbdcc6 Compare May 5, 2023 03:45
@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch from 6dbdcc6 to 5e93dec Compare January 14, 2024 22:22
@thnkslprpt thnkslprpt force-pushed the fix-2175-apply-consistent-event-id-names branch from 5e93dec to f05436b Compare April 20, 2024 05:04
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.

Inconsistent Event ID naming
2 participants