feat: Add notes about testnet proposal submission #8
Conversation
#PRMaster
chore: explain provider oracle
PavelInjective
force-pushed
the
testnet-proposal-docs
branch
from
6ec2ca3 to
7b4903a
Compare
WalkthroughThe "Injective Cheat Sheet" document has been updated to include a new section titled "Creating Proposals on Testnet." This section emphasizes the importance of coordinating with the Injective development team to confirm proposals immediately after transaction submission. The rest of the document remains mostly unchanged, covering topics such as contributing to the Burn Auction Pool, creating transactions through various methods, and adding token metadata. The new section is strategically placed between existing subsections. Changes
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
docs/develop/cheat-sheet/index.mdx (1)
118-121: Approved with suggestions for improvement.The addition of the "Creating Proposals on Testnet" section is a valuable inclusion to the Injective Cheat Sheet. Its placement within the document is appropriate, and it provides crucial information about coordinating with the Injective dev team.
To further enhance this section, consider expanding it with more detailed information about the proposal creation process on Testnet, as suggested in the previous comment. This would provide users with a more comprehensive guide and improve the overall utility of the cheat sheet.
| ## Creating Proposals on Testnet | ||
|
|
||
| To sucessfully pass a proposal on Testnet, please, coordinate with the Injective dev team to confirm it right after a transaction is submitted. | ||
|
|
There was a problem hiding this comment.
Fix typo and consider expanding the section content.
There's a typo in the word "successfully" on line 120. Additionally, while the information provided is valuable, consider expanding this section to provide more details about the proposal creation process on Testnet. This could include:
- Steps to create a proposal
- Required parameters or information
- How to contact the Injective dev team for coordination
- Any specific timeframes or considerations for Testnet proposals
Here's a suggested fix for the typo:
-To sucessfully pass a proposal on Testnet, please, coordinate with the Injective dev team to confirm it right after a transaction is submitted.
+To successfully pass a proposal on Testnet, please coordinate with the Injective dev team to confirm it right after a transaction is submitted.📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Creating Proposals on Testnet | |
| To sucessfully pass a proposal on Testnet, please, coordinate with the Injective dev team to confirm it right after a transaction is submitted. | |
| ## Creating Proposals on Testnet | |
| To successfully pass a proposal on Testnet, please coordinate with the Injective dev team to confirm it right after a transaction is submitted. | |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- docs/develop/cheat-sheet/index.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/develop/cheat-sheet/index.mdx
[typographical] ~121-~121: Consider adding a comma here.
Context: ...or example,40000000000000000000inj). After that you should contact the Injective dev te...(FOR_THAT_COMMA)
| ## Creating Proposals on Testnet | ||
|
|
||
| To successfully pass the proposal for testnet, `YOUR_DEPOSIT` should be slightly less than `min_deposit` | ||
| value (for example, `40000000000000000000inj`). After that you should contact the Injective dev team. Dev team will | ||
| top up your deposit to `min_deposit` and vote for your proposal. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance the new section on Creating Proposals on Testnet
Thank you for adding this new section and addressing the typo from the previous review. To further improve it:
-
Consider expanding the content as suggested in the past review. Include steps to create a proposal, required parameters, and specific timeframes for Testnet proposals.
-
Improve grammar and punctuation:
- Add a comma after "After that" on line 121.
- Consider rephrasing "To successfully pass the proposal for testnet" to "To submit a proposal on testnet".
-
Enhance formatting for better readability:
- Use bullet points or numbered steps for the process.
- Highlight important values like
YOUR_DEPOSITandmin_depositusing inline code formatting.
Here's a suggested revision:
## Creating Proposals on Testnet
To submit a proposal on testnet:
1. Set `YOUR_DEPOSIT` to be slightly less than the `min_deposit` value (e.g., `40000000000000000000inj`).
2. Submit your proposal transaction.
3. Contact the Injective dev team. They will:
- Top up your deposit to reach `min_deposit`.
- Vote on your proposal.
Note: Coordination with the Injective dev team is crucial for successfully passing proposals on testnet.Would you like assistance in implementing these suggestions or expanding the content further?
🧰 Tools
🪛 LanguageTool
[typographical] ~121-~121: Consider adding a comma here.
Context: ...or example,40000000000000000000inj). After that you should contact the Injective dev te...(FOR_THAT_COMMA)
Summary by CodeRabbit