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.

Sign up for GitHub

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

Editorial updates on column IDs and Display Names #582

Merged
merged 9 commits into from
Oct 17, 2024
Merged

Editorial updates on column IDs and Display Names #582

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7883224
editorial updates on column IDs and Display Names
jpradocueva Oct 2, 2024
be4655a
Merge branch 'working_draft' into editorial-updates
jpradocueva Oct 8, 2024
f4d7dba
updates to example and criteria
jpradocueva Oct 15, 2024
020a569
separate sentence
jpradocueva Oct 15, 2024
35f0eed
align the last bullet point
jpradocueva Oct 15, 2024
465e3f4
Merge branch 'working_draft' into editorial-updates
jpradocueva Oct 16, 2024
37afd60
Update EDITORIAL_GUIDELINES.md
jpradocueva Oct 16, 2024
d6effc6
editorial-updates: adding Column Values formating
ijurica Oct 16, 2024
7a3b829
Merge branch 'working_draft' into editorial-updates
jpradocueva Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions EDITORIAL_GUIDELINES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,11 @@ These guidelines can be modified through a Pull Request (PR), which the members

* **Normative Requirements as a Bullet List**: Normative statements (those using Normative Keywords) should be written as bullet points instead of lengthy sentences.

* **Column IDs:** They SHOULD be used in normative text sections, such as when specifying mandatory rules, schema definitions, or other implementation-related content. These Column IDs should be formatted without spaces and should match the exact naming conventions used in the schema (e.g., CommitmentDiscountID).

* **Display Names:** They SHOULD be used in introductory or explanatory sections where natural language context is more appropriate. In these sections, display names should follow normal text conventions, including spaces between words (e.g., Commitment Discount ID).
ijurica marked this conversation as resolved.
Show resolved Hide resolved


### Example

> **2.28. Pricing Quantity**
Expand Down
Loading