Skip to content

docs(readme): document steps to create an issue in support repo #2001

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.

Sign up for GitHub

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

Merged
troian merged 1 commit into from
Sep 9, 2025
Merged

docs(readme): document steps to create an issue in support repo #2001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This is just a short list of ideas, if you have other ideas for contributing ple

#### 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.
Copy link

@coderabbitai coderabbitai bot Sep 9, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

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.


#### I have a (great) idea

Expand Down Expand Up @@ -260,7 +260,7 @@ There is a forum which you are welcome to join to discuss Akash Network, Kuberne

### Roadmap

* Browse open issues in [overclock/akash](https://github.com/akash-network/node/issues)
* Browse open issues in [support](https://github.com/akash-network/support/issues)

## License

Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,15 @@
For a high-level overview of the Akash protocol and network economics, check out the [whitepaper](https://ipfs.io/ipfs/QmVwsi5kTrg7UcUEGi5UfdheVLBWoHjze2pHy4tLqYvLYv); a detailed protocol definition can be
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 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/akash-network/node)
For an indepth understanding of the code [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/akash-network/node)
Copy link

@coderabbitai coderabbitai bot Sep 9, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix typo: “indepth” → “in-depth”

-For an indepth understanding of the code [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/akash-network/node)
+For an in-depth understanding of the code [![Ask DeepWiki](https://deepwiki.com/badge.svg)](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 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/akash-network/node)
For an in-depth understanding of the code [![Ask DeepWiki](https://deepwiki.com/badge.svg)](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.


# 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)

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.

To become a contributor, please see the guide on [contributing](CONTRIBUTING.md)

# Branching and Versioning

Expand Down Expand Up @@ -78,12 +84,6 @@ Or install a specific version with [GoDownloader](https://github.com/goreleaser/
$ curl -sSfL https://raw.githubusercontent.com/akash-network/node/main/install | sh -s -- v0.22.0
```

# Roadmap and contributing

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.

To become a contributor, please see the guide on [contributing](CONTRIBUTING.md)

## Development environment
[This doc](https://github.com/akash-network/node/blob/main/_docs/development-environment.md) guides through setting up local development environment

Expand Down
Loading