Skip to content

Add region, subregion, and rez naming conventions #12

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

Open
nick-gorman wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add region, subregion, and rez naming conventions #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions naming-conventions
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Project naming conventions

# Region and subregion naming

- Refer to NEM regions with `region` or `region_id` for variables or column names. In docs,
the use of `regions`, `NEM regions`, or `NEM region` is at the discretion of the author.
- Refer to ISP subregions with `subregion` or `subregion_id` for variables or column names.
In docs, the use of `subregions`, `ISP subregions`, or `ISP subregion` is at the
discretion of the author.
- Refer to renewable energy zones with `rez` or `rez_id` for variables or column names.
In docs, the use of `REZ`, `REZs`, or `Renewable Energy Zones` is at the
discretion of the author.
- The `_id` suffix should always (and only) be used when referring to the naming IDs
of regions, subregions, and rezs.