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.

Sign up for GitHub

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

Jump to bottom

Chore: Add naming conventions to documentation #189

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

Chore: Add naming conventions to documentation #189

wants to merge 1 commit into from

Conversation

ModeSevenIndustrialSolutions
Copy link
Contributor

@ModeSevenIndustrialSolutions ModeSevenIndustrialSolutions commented Oct 9, 2024 •
edited
Loading

Will pass linting if/when we merge: #188

tykeal
tykeal reviewed Oct 23, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
tykeal
tykeal reviewed Oct 23, 2024
View reviewed changes
Copy link
Member

@tykeal tykeal left a comment

Choose a reason for hiding this comment

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

I know I'm being a little pedantic, but I would like the idea around the generic Gerrit workflows to be reworked. See my comment in the file itself.

tykeal
tykeal requested changes Nov 1, 2024
View reviewed changes
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
eb-oss
eb-oss requested changes Nov 6, 2024
View reviewed changes
Copy link
Contributor

@eb-oss eb-oss left a comment

Choose a reason for hiding this comment

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

I noted a couple small corrections to be made, but I think this is a solid starting point for both our naming scheme, and our overall documentation.

README.md

### Workflow Naming Prefixes

The table below lists prefixes that applied, inside square brackets, to
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The table below lists prefixes that applied, inside square brackets, to
The table below lists prefixes that are applied, inside square brackets, to

README.md
embedded behaviours mean a naming convention helps distinguish the different
types.

They fall into three specific types:
Copy link
Contributor

Choose a reason for hiding this comment

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

This is now four types.

tykeal
tykeal reviewed Nov 8, 2024
View reviewed changes
Copy link
Member

@tykeal tykeal left a comment

Choose a reason for hiding this comment

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

I'm good with this. Please adress @eb-oss 's comments though

README.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tykeal tykeal tykeal requested changes

@eb-oss eb-oss eb-oss requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@ModeSevenIndustrialSolutions ModeSevenIndustrialSolutions

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ModeSevenIndustrialSolutions @tykeal @eb-oss