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

Update new_release_team.md #668

Closed
wants to merge 0 commits into from

Conversation

Smith-JackSmith
Copy link

Chevrons (< >) for Placeholders, permalink instructions, and example:

Chevrons are a widely understood convention for placeholders, improving readability and making it easier to spot text that needs replacement.

Detailed instructions for generating a permalink to a line number in distribution.yml file, which evolves over time.

Example facilitates the correct format.

@nuclearsandwich
Copy link
Collaborator

Thanks for these suggestions. I wish GitHub made it possible to provide instructions that don't "leak" into the final template because I really dislike cluttering the issue text itself with text that's only relevant to the submitter and not the resulting issue. But these instructions aren't for me, they're for contributors so my tastes can take a backseat. Do you think this information would be as helpful if it were commented out of the markdown result using html comments, but still visible to people filling out the template?

Detailed instructions for generating a permalink to a line number in distribution.yml file, which evolves over time.

What I would really like to request is the PR number that adds the source repository to ros/rosdistro. When a reviewer receives a permalink, which uses the commit ID, they must also check that the linked repository is actually present in the master branch of ros/rosdistro in order to verify that the listed repository actually merged. Because ros/rosdistro uses squash-merge, we cannot necessarily check for the commit's presence on the main branch as it may have been rewritten if they submitted the request before the PR merged. If there was a URL query to jump to a specific regular expression pattern in a file on GitHub, then we could very nearly automate this by seeking /^ ${REPOSITORY}:$/ in active distribution.yaml files.

@Smith-JackSmith
Copy link
Author

@nuclearsandwich

I am not sure I understand what you are asking here, or if you are really asking a rhetorical question.

Can't all this be handled by a README.md in the appropriate place ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants