Add note on experimental semantic convention implementation, prefix semantics headers with experimental tag
#970
Conversation
Codecov Report
@@ Coverage Diff @@
## main #970 +/- ##
=======================================
Coverage 95.38% 95.38%
=======================================
Files 161 161
Lines 6817 6817
=======================================
Hits 6502 6502
Misses 315 315
|
|
@jsuereth do you think this declaration for semantic convention is sufficient, or we also need to declare the status in the release document? |
Good point. We should be adding it in release description for 1.0.0 as done by other SIGs : |
| @@ -65,6 +65,12 @@ Refer to the [ABI Policy](./docs/abi-policy.md) for more details. To summarise: | |||
| allowed to break existing stable interfaces. Feature flags will be removed | |||
| once we have a stable implementation for the signal. | |||
|
|
|||
| * As an exception, small experimental features in otherwise stable signals/components | |||
| mayn't necessarily be released under feature flag. These would be flagged as experimental | |||
| by adding a `NOTE` in it's header file - either at the beginning of file, or as the comment for | |||
There was a problem hiding this comment.
non-blocking comment -
Would it make sense to call the header file experimental_* to further clarify?
I think you could do this and still provide backwards compatibility later by forward-chain including the new non-experimental folder when it stabilizes. Just a thought.
There was a problem hiding this comment.
Yes this does makes sense. Will incorporate this.
lalitb
changed the title
experimental tag
Fixes 968
Changes
experimenta_*prefix.cppextension to.ccto be consistent with other src files.cc @jsuereth
For significant contributions please make sure you have completed the following items:
CHANGELOG.mdupdated for non-trivial changes