Replies: 2 comments
-
I was hoping that we could link to this discussion from other tickets / PRs and then those references would show up here. That way we could have a compilation of all of the comments that need to be codified as coding conventions. However, I'm not seeing them so I'm going to have to figure out the right approach. |
Beta Was this translation helpful? Give feedback.
-
ProposalWe want to be able to be able to collect coding conventions (and tech huddle topics, etc) in one place without requiring someone to disrupt what they are doing and add the convention / topic to a central public repository (i.e. coding conventions document in GH). The reason to not do this is 1) it's disruptive 2) we don't want just anyone to add coding conventions without review. Instead, the idea would be that we'd allow the developer or stakeholder to annotate their comments with a link to an issue, discussion, label to indicate their preference to include the comment as a convention. Then as part of a separate process a developer who is responsible for coding conventions could review these comments and add them to the central repository. Solution 1 Reference a Discussion NumberUnfortunately, this did not have the desired effect. There's no back reference created in the discussion (from the issue or PR) so the only way to collect the coding conventions is to do a search for discussion #3849 in the Issue Search. Doing the search under Pull Requests is similar but does not include issues so not as useful. Solution 2 Reference an Issue NumberReferencing the "Document coding convention" ticket (#3867) in PRs has the desired effect. We can reference the issue number in a specific comment that we think should be converted into a coding convention. Solution 3 Apply a "coding convention" label to the Pull Request or IssueThat way if we wanted to reference a label you could add the following URL to the markdown That would link us to all issue with that label. Not exactly what we're looking for but it's a start. The negative of this would be that we are applying the label to the whole PR / issue so a developer would need to parse all the comments to figure out which one refers to a coding convention. So we have some "falling through the cracks" potential here. Solution 4 - Add an annotation plugin to browser (Chrome, Firefox) that would allow us toPros:
Cons:
Other issues to consider
Resources
|
Beta Was this translation helpful? Give feedback.
-
Draft of coding conventions
Resources
Codifying Coding Conventions
Enforcing Coding Conventions
Coding Convetions
REST APIs
Style Guides (to be considered)
Groovy
Java
JSON
JavaScript
Typescript
React
Beta Was this translation helpful? Give feedback.
All reactions