Skip to content

Commit

Permalink
Formatting for comment 1
Browse files Browse the repository at this point in the history
  • Loading branch information
joshmoore committed Mar 13, 2024
1 parent b072ae3 commit 96a9498
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions rfc/1/comment_1.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
# RFC 1
*Review to RFC 1 from @LucaMarconato and @melonora.*
# Comment to [RFC 1](../1) from @LucaMarconato and @melonora.*

| Name | GitHub Handle | Institution |
|------------------------|---------------|----------------------|
| Wouter-Michiel Vierdag | melonora | EMBL |
| Luca Marconato | LucaMarconato | EMBL |

## Comments on implementations

## Comments
### Comments on implementations
- Currently diagram does not reflect text. Text says *"If sufficient endorsements, including two in-progress
implementations, are available, then the RFC can progress (S1) to the SPEC phase below."*. The "code" checks are not
visible in the diagram which could make someone think that implementation is only of importance at the end of the RFC
Expand Down Expand Up @@ -38,11 +42,12 @@ based on this example in which case the comment would have the status of address
author I would prefer the meaning "the review process lasts maximum 4 weeks", while as a reviewer I would prefer "I have
up to 4 weeks to submit the review".

### Typos/minor edits
## Typos/minor edits

- This sentence under section 'Stakeholders' paragraph 2 is truncated: "However, once the draft has reached a certain
stage that it is ready for comments, Editors will merge it as a record of the fact that the suggestion."

### Consistency between the diagram and text description
## Consistency between the diagram and text description

- The sentence "However, once the draft has reached a certain stage that it is ready for comments, Editors will merge
it as a record of the fact that the suggestion." seems not to be reflected in the diagram.
Expand All @@ -52,4 +57,4 @@ already in the RFC phase.
- Related to above, we suggest to use the same wording in the diagram and in the text: for instance the "RFC persists"
wording is not present in the text.
- The diagram doesn't contain the equivalent points for the 🕐 comments that are present in the text. I would consider
unifying the clocks and the traffic lights.
unifying the clocks and the traffic lights.

0 comments on commit 96a9498

Please sign in to comment.