docs(readme): document steps to create an issue in support repo #2001
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughUpdated documentation: fixed a typo in README, consolidated and added a “Roadmap and contributing” section linking to CONTRIBUTING.md, and changed two issue-reporting references in CONTRIBUTING.md to point at the Akash Network support issues repository. No code or API changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Pre-merge checks (2 passed, 1 warning)❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
Poem
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 📜 Recent review detailsConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)
✨ Finishing Touches🧪 Generate unit tests
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
README.md (1)
18-25: Polish heading, grammar, and link to support issue chooserTitle case the heading, fix wording, and point to the new-issue chooser. Add a period to the last sentence.
-# Roadmap and contributing +# Roadmap and Contributing @@ -Should you with to suggest feature or report an issue please open ticket in [support repo](https://github.com/akash-network/support/issues) +To suggest a feature or report an issue, please open a ticket in the [support repository](https://github.com/akash-network/support/issues/new/choose). @@ -Akash is written in Golang and is Apache 2.0 licensed - contributions are welcomed whether that means providing feedback, testing existing and new feature or hacking on the source. +Akash is written in Go and is Apache 2.0 licensed—contributions are welcome, whether that means providing feedback, testing existing and new features, or hacking on the source. @@ -To become a contributor, please see the guide on [contributing](CONTRIBUTING.md) +To become a contributor, please see the guide on [contributing](CONTRIBUTING.md).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CONTRIBUTING.md(1 hunks)README.md(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
- GitHub Check: sims
- GitHub Check: release-dry-run
- GitHub Check: lint
- GitHub Check: coverage
- GitHub Check: tests
- GitHub Check: build-bins
| #### I've found a typo | ||
|
|
||
| * A Pull Request is not necessary. Raise an [Issue](https://github.com/akash-network/node/issues) and we'll fix it as soon as we can. | ||
| * A Pull Request is not necessary. Raise an [Issue](https://github.com/akash-network/support/issues) and we'll fix it as soon as we can. |
There was a problem hiding this comment.
Deep-link to “New issue” chooser in support repo
Linking to the issues list increases a click; point directly to the new-issue chooser.
-* A Pull Request is not necessary. Raise an [Issue](https://github.com/akash-network/support/issues) and we'll fix it as soon as we can.
+* A Pull Request is not necessary. Raise an [issue](https://github.com/akash-network/support/issues/new/choose) and we'll fix it as soon as we can.📝 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.
Suggested change
| * A Pull Request is not necessary. Raise an [Issue](https://github.com/akash-network/support/issues) and we'll fix it as soon as we can. | |
| * A Pull Request is not necessary. Raise an [issue](https://github.com/akash-network/support/issues/new/choose) and we'll fix it as soon as we can. |
🤖 Prompt for AI Agents
In CONTRIBUTING.md around line 31, the current link points to the issues list;
update it to deep-link directly to the new-issue chooser by replacing the URL
https://github.com/akash-network/support/issues with
https://github.com/akash-network/support/issues/new so clicking goes straight to
the "New issue" form.
| found in the [design documentation](https://docs.akash.network); and the target workload definition spec is [here](https://docs.akash.network/sdl). | ||
|
|
||
| For an indept understanding of the code [](https://deepwiki.com/akash-network/node) | ||
| For an indepth understanding of the code [](https://deepwiki.com/akash-network/node) |
There was a problem hiding this comment.
Fix typo: “indepth” → “in-depth”
-For an indepth understanding of the code [](https://deepwiki.com/akash-network/node)
+For an in-depth understanding of the code [](https://deepwiki.com/akash-network/node)📝 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.
Suggested change
| For an indepth understanding of the code [](https://deepwiki.com/akash-network/node) | |
| For an in-depth understanding of the code [](https://deepwiki.com/akash-network/node) |
🤖 Prompt for AI Agents
In README.md around line 16, the word "indepth" is misspelled; replace it with
the hyphenated form "in-depth" so the sentence reads "For an in-depth
understanding of the code ..." and keep the rest of the line (the badge link)
unchanged.
Signed-off-by: Artur Troian <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow-up issues.
I have...
!to the type prefix if API or client breaking changeCHANGELOG.md