Skip to content

Conversation

@taliaga
Copy link
Contributor

@taliaga taliaga commented Jul 10, 2025

Updating contributing guide:

  • Change order in "Getting started" section to promote self-review before push
  • Clarify Review Process section, confusing use of owner term?
  • Images: screenshots vs diagrams, promoting diagrams as code :)

Fun facts worth noting:

  • The contributing guide for updating the contributing guide is the same contributing guide
  • Some contributions to the contributing guide could eventually be both a violation and an improvement of the guide

@taliaga taliaga self-assigned this Jul 10, 2025
@github-actions

This comment has been minimized.

@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/194

@github-actions

This comment has been minimized.

@github-actions

This comment has been minimized.

@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/194

@github-actions

This comment has been minimized.

taliaga added 5 commits July 10, 2025 15:16
It's confusing to say documentation is owned by everyone and then ask to discuss changes with owners.
@taliaga taliaga force-pushed the upd-contributing branch from d094c10 to 82b76b6 Compare July 10, 2025 13:16
@github-actions

This comment has been minimized.

@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/194

@github-actions

This comment has been minimized.

@msimberg
Copy link
Collaborator

msimberg commented Jul 10, 2025

Thanks @taliaga! I'll refer you to this comment for now about the spell checker: #177 (comment).

Edit: buttons are hard. Fixed the link.

Copy link
Collaborator

@msimberg msimberg left a comment

Choose a reason for hiding this comment

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

A few non-blocking comments. This looks like a nice addition to me. Thanks @taliaga!


!!! tip
Do you need a screenshot, or can a text description also work?
#### Screenshots
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think screenshot could be added to .github/actions/spelling/allow.txt. Wikipedia seems to use "screenshot" as well (not "screen shot"), so the spell checker is wrong here.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

adding codeowners and screenshots. I wonder which tool/config are you using to keep the alphabetical order? my sort yields something different so I just placed them manually

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah, fair question. Emacs' sort-lines 🙃 I suppose mine sorts caps before lower case, whereas yours maybe mixes them?

Co-authored-by: Mikael Simberg <[email protected]>
Co-authored-by: Ben Cumming <[email protected]>
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

This comment has been minimized.

@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/194

@github-actions
Copy link

preview available: https://docs.tds.cscs.ch/194

@taliaga
Copy link
Contributor Author

taliaga commented Jul 11, 2025

Thanks reviewers

@msimberg msimberg added this pull request to the merge queue Jul 11, 2025
Merged via the queue into main with commit a99f96d Jul 11, 2025
3 checks passed
@msimberg msimberg deleted the upd-contributing branch July 11, 2025 10:50
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.

4 participants