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

[ADMIN] Add editorial guidelines document #501

Merged
merged 39 commits into from
Sep 3, 2024

Conversation

jpradocueva
Copy link
Contributor

This PR supersedes PR #499

@jpradocueva jpradocueva added the repo maintenance Issues related to maintenance tasks on the repo label Jul 8, 2024
@jpradocueva jpradocueva requested a review from a team as a code owner July 8, 2024 23:35
@jpradocueva jpradocueva added this to the v1.1 milestone Jul 8, 2024
@jpradocueva jpradocueva linked an issue Jul 8, 2024 that may be closed by this pull request
@jpradocueva
Copy link
Contributor Author

jpradocueva commented Jul 9, 2024

  • Members are to review PR #501 and provide comments to ensure alignment with the proposed editorial changes.

EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
Co-authored-by: Karl <133434112+kk09v@users.noreply.github.com>
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
@jpradocueva
Copy link
Contributor Author

Examples of how to implement the guidelines in Markdown:

Markdown

Column Names

  • Pricing Quantity
  • Pricing Unit
  • Consumed Quantity
  • Consumed Unit

Column IDs

  • ChargeClass
  • ChargeCategory
  • PricingQuantity

Normative Keywords

  • MUST, MAY, MUST NOT

Attribute Names

  • Currency Code Format

Attributes ID

  • CurrencyCodeFormat
  • UnitFormat

Glossary

  • service

EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
EDITORIAL_GUIDELINES.md Outdated Show resolved Hide resolved
@jpradocueva
Copy link
Contributor Author

jpradocueva commented Aug 16, 2024

Agreements Reached, Members Group, Aug 15:

  • The guidelines will be reviewed, and a decision will be made next week on whether to apply them before the 1.1 release.
  • The group discussed whether the guidelines should be applied before or after the 1.1 release.

@jpradocueva
Copy link
Contributor Author

Action Items, Maintainers, Aug 19:

  • [Maintainers-#501] Prepare to apply guidelines post-1.1, focusing on readability improvements in the meantime, e.g. normative statement should be presented in bullet point format

@jpradocueva
Copy link
Contributor Author

jpradocueva commented Aug 23, 2024

Action Items, Members' call on Aug 22:

  • [Members-#501] Joaquin @jpradocueva : To prepare a PR with suggestions for handling table formatting.

jpradocueva and others added 12 commits August 29, 2024 12:26
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
Co-authored-by: Michael Flanakin <flanakin@users.noreply.github.com>
@jpradocueva jpradocueva merged commit b9b8a24 into working_draft Sep 3, 2024
2 checks passed
@jpradocueva jpradocueva deleted the editorial_guidelines_2 branch September 3, 2024 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
repo maintenance Issues related to maintenance tasks on the repo
Projects
Status: W.I.P
Development

Successfully merging this pull request may close these issues.

[EDITORIAL] Editorial Style Reference (Proposal)
6 participants