Skip to content

Improve codebase's message template #873

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Niloth-p
Copy link
Contributor

@Niloth-p Niloth-p commented Jul 8, 2025

Add backticks for branch names.
Motivation: Updating example screenshots in integration docs.


How did you test this PR?
I did not test the changes.


I added the automatic changes on linting and formatting (on editor save) as the first commit, so that the actual functional changes are identifiable clearly in a separate commit.

Would we prefer to:

  • Do this sort of formatting updates to all the files together? In that case, should I remove the changes in the first commit, and just add backticks to the templates in the format() calls?
  • Merge this and worry about the rest later?
Self-review checklist
  • Self-reviewed the changes for clarity and maintainability
    (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.

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

Successfully merging this pull request may close these issues.

2 participants