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

[WIP] Checklist #211

Closed
wants to merge 0 commits into from
Closed

[WIP] Checklist #211

wants to merge 0 commits into from

Conversation

rolfedh
Copy link
Contributor

@rolfedh rolfedh commented Sep 13, 2023

Closes #206
This is an early draft. No need to review or comment at this stage.

@rolfedh rolfedh requested a review from a team as a code owner September 13, 2023 15:01
@mjahoda
Copy link
Contributor

mjahoda commented Sep 14, 2023

Thank you for creating a comprehensive draft of the check list in such a short time. I am just thinking of creating another check list, much briefer, containing only the "rules" that are most commonly problematic. We could include both check lists (the brief one, your "full"). If you and also other members agree, I'd try to propose the items for a short check list. If this'll sound like a non-sense to others, I'll focus only on reviewing your draft.

Just one nitpick immediatelly: we probably use sentence case in the rest of the guide.

Edit: I'm taking back the "check list" term. IBM Style mandates "checklist" as you write. I'm sorry for the noise.

@rolfedh
Copy link
Contributor Author

rolfedh commented Sep 18, 2023

I am just thinking of creating another check list,

Hi @mjahoda - let's move this conversation to the issue, #206.

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.

Do we have a Modular Documentation checklist?
2 participants