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

docs: Add cohort information #1572

Merged
merged 3 commits into from
May 14, 2024
Merged

docs: Add cohort information #1572

merged 3 commits into from
May 14, 2024

Conversation

YazzyYaz
Copy link
Contributor

@YazzyYaz YazzyYaz commented May 14, 2024

Summary by CodeRabbit

  • Documentation
    • Updated the Foundation Delegation Program with details about validator seat cohorts, including seat numbers and application opening dates for each cohort.
      • Cohort 1: 50 Validator Seats
      • Cohort 2: 15 Validator Seats (Applications open June 1, 2024)
      • Cohort 3: 15 Validator Seats (Applications open October 1, 2024)
      • Cohort 4: 20 Validator Seats (Applications open February 1, 2025)

@YazzyYaz YazzyYaz added the documentation Improvements or additions to documentation label May 14, 2024
Copy link
Contributor

coderabbitai bot commented May 14, 2024

Walkthrough

The recent update to the community/foundation-delegation-program.md introduces detailed information about different cohorts of validator seats. It specifies the number of seats available in each cohort and the respective dates when applications open, enhancing clarity and planning for potential validators.

Changes

Files Change Summary
community/foundation-delegation-program.md Added details about validator seat cohorts, including seat numbers and application dates.

In a meadow bright with digital light,
Validators gather, a future in sight.
Seats are set, in cohorts they grow,
June, October, and February's glow.
Together we build, a network so grand,
In the blockchain's ever-expanding land.
🐇✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

github-actions bot commented May 14, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-05-14 18:51 UTC

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Out of diff range and nitpick comments (3)
community/foundation-delegation-program.md (3)

Line range hint 43-43: Consider adding a hyphen and a preposition for clarity.

- first, second, and third place based eligibility criteria
+ first, second, and third-place based on eligibility criteria

Line range hint 106-106: Consider using 'afterward' for consistency with American English.

- afterwards
+ afterward

Line range hint 122-122: Consider using 'before' instead of 'prior to' for conciseness.

- prior to the date of being delegated to.
+ before the date of being delegated to.
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 44523ea and 071310b.
Files selected for processing (1)
  • community/foundation-delegation-program.md (1 hunks)
Additional Context Used
LanguageTool (6)
community/foundation-delegation-program.md (6)

Near line 43: This expression is usually spelled with a hyphen.
Context: ...divided into first, second, and third place based eligibility criteria outlined in this d...


Near line 43: Possible missing preposition found.
Context: ... first, second, and third place based eligibility criteria outlined in this document. *...


Near line 106: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...hed/tombstoned (cannot apply for 1 year afterwards) * Getting jailed more than once during...


Near line 122: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... you are reapplying) is exactly 1 month prior to the date of being delegated to. ### Ap...


Near line 169: Unpaired symbol: ‘[’ seems to be missing
Context: ...eir respective delegations. * [Cohort 1](https://docs.google.com/spreadsheets/d/...


Near line 176: Use a comma before ‘so’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ll receive a feedback form every quarter so the program can be continually improved...

Additional comments not posted (5)
community/foundation-delegation-program.md (5)

169-169: The information about Cohort 1 is clear and well-structured.


170-170: The information about Cohort 2 is clear and well-structured.


171-171: The information about Cohort 3 is clear and well-structured.


172-172: The information about Cohort 4 is clear and well-structured.


173-173: The addition of a blank line improves readability.

community/foundation-delegation-program.md Outdated Show resolved Hide resolved
community/foundation-delegation-program.md Outdated Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Out of diff range and nitpick comments (3)
community/foundation-delegation-program.md (3)

Line range hint 43-43: Consider hyphenating "first, second, and third place" for clarity.

- first, second, and third place
+ first-, second-, and third-place

Line range hint 106-106: Consider changing "afterwards" to "afterward" for consistency with American English.

- afterwards
+ afterward

Line range hint 122-122: Consider replacing "prior to" with "before" for conciseness.

- prior to
+ before
Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 071310b and 1390931.
Files selected for processing (1)
  • community/foundation-delegation-program.md (1 hunks)
Additional Context Used
LanguageTool (4)
community/foundation-delegation-program.md (4)

Near line 43: This expression is usually spelled with a hyphen.
Context: ...divided into first, second, and third place based eligibility criteria outlined in this d...


Near line 106: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...hed/tombstoned (cannot apply for 1 year afterwards) * Getting jailed more than once during...


Near line 122: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... you are reapplying) is exactly 1 month prior to the date of being delegated to. ### Ap...


Near line 169: Unpaired symbol: ‘[’ seems to be missing
Context: ...eir respective delegations. * [Cohort 1](https://docs.google.com/spreadsheets/d/...

Additional comments not posted (2)
community/foundation-delegation-program.md (2)

169-169: Ensure the link is correctly formatted.

- * [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0) 50 Validator Seats
+ * [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats

176-176: Consider adding a comma before 'so' for clarity.

- Validators in the program will receive a feedback form every quarter, so
+ Validators in the program will receive a feedback form every quarter, so

community/foundation-delegation-program.md Outdated Show resolved Hide resolved
@jcstein jcstein merged commit 821a437 into main May 14, 2024
2 checks passed
@jcstein jcstein deleted the yaz.update_cohorts branch May 14, 2024 18:50
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 1390931 and ff62b6c.
Files selected for processing (1)
  • community/foundation-delegation-program.md (1 hunks)
Additional Context Used
LanguageTool (7)
community/foundation-delegation-program.md (7)

Near line 43: This expression is usually spelled with a hyphen.
Context: ...divided into first, second, and third place based eligibility criteria outlined in this d...


Near line 43: Possible missing preposition found.
Context: ... first, second, and third place based eligibility criteria outlined in this document. *...


Near line 70: You might be missing the article “the” here.
Context: ...t validator for at least 1 month before application deadline * Run a bridge node (on mainne...


Near line 106: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...hed/tombstoned (cannot apply for 1 year afterwards) * Getting jailed more than once during...


Near line 119: Possible missing comma found.
Context: ...ation The program will be divided into cohorts with applications open for new applican...


Near line 122: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ... you are reapplying) is exactly 1 month prior to the date of being delegated to. ### Ap...


Near line 169: Unpaired symbol: ‘[’ seems to be missing
Context: ...eir respective delegations. * [Cohort 1](https://docs.google.com/spreadsheets/d/...

@@ -166,7 +166,12 @@ in the active validator set.
The Foundation will report each cohort’s composition and the duration of
their respective delegations.

* [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure the link is correctly formatted.

- * [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0) 50 Validator Seats
+ * [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats
* [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats

@@ -166,7 +166,12 @@
The Foundation will report each cohort’s composition and the duration of
their respective delegations.

* [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats
* Cohort 2: 15 Validator Seats (Applications open June 1, 2024)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistency in date formats.

- * Cohort 2: 15 Validator Seats (Applications open June 1, 2024)
+ * Cohort 2: 15 Validator Seats (Applications open June 1, 2024)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* Cohort 2: 15 Validator Seats (Applications open June 1, 2024)

@@ -166,7 +166,12 @@
The Foundation will report each cohort’s composition and the duration of
their respective delegations.

* [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats
* Cohort 2: 15 Validator Seats (Applications open June 1, 2024)
* Cohort 3: 15 Validator Seats (Applications open October 1, 2024)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistency in date formats.

- * Cohort 3: 15 Validator Seats (Applications open Oct 1, 2024)
+ * Cohort 3: 15 Validator Seats (Applications open October 1, 2024)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* Cohort 3: 15 Validator Seats (Applications open October 1, 2024)
* Cohort 3: 15 Validator Seats (Applications open October 1, 2024)

* [Cohort 1](https://docs.google.com/spreadsheets/d/1Fxu9uYJ4wxfHChEiSg5bmXAMU8IZSq7J3GYDCFgk1HA/edit#gid=0): 50 Validator Seats
* Cohort 2: 15 Validator Seats (Applications open June 1, 2024)
* Cohort 3: 15 Validator Seats (Applications open October 1, 2024)
* Cohort 4: 20 Validator Seats (Applications open February 1, 2025)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure consistency in date formats.

- * Cohort 4: 20 Validator Seats (Applications open Feb 1, 2025)
+ * Cohort 4: 20 Validator Seats (Applications open February 1, 2025)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
* Cohort 4: 20 Validator Seats (Applications open February 1, 2025)
* Cohort 4: 20 Validator Seats (Applications open February 1, 2025)

## Feedback process

Validators in the program will receive a feedback form every quarter so
Validators in the program will receive a feedback form every quarter, so
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding a comma before 'so' for clarity.

- Validators in the program will receive a feedback form every quarter so the program can be continually improved.
+ Validators in the program will receive a feedback form every quarter, so the program can be continually improved.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
Validators in the program will receive a feedback form every quarter, so
Validators in the program will receive a feedback form every quarter, so the program can be continually improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants