Skip to content

Commit

Permalink
Switch to using akash-api-fork
Browse files Browse the repository at this point in the history
  • Loading branch information
@dusanstanis
dusanstanis committed Jun 27, 2024
1 parent 279cdbc commit b185eda
Show file tree
Hide file tree
Showing 259 changed files with 966 additions and 913 deletions.
12 changes: 6 additions & 6 deletions .chglog/config.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ style: github
template: CHANGELOG.tpl.md
info:
title: CHANGELOG
repository_url: https://github.com/akash-network/node
repository_url: https://github.com/spheronFdn/akash-node
options:
commits:
# filters:
Expand All @@ -12,11 +12,11 @@ options:
# - perf
# - refactor
commit_groups:
title_maps:
feat: Features
fix: Bug Fixes
perf: Performance Improvements
refactor: Code Refactoring
title_maps:
feat: Features
fix: Bug Fixes
perf: Performance Improvements
refactor: Code Refactoring
header:
pattern: "^(\\w*)(?:\\(([\\w\\$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$"
pattern_maps:
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ are the most critical to review. -->

### 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.*
_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...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] added `!` to the type prefix if API or client breaking change
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/akash-network/node/blob/main/CONTRIBUTING.md#paperwork-for-pull-requests))
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/spheronFdn/akash-node/blob/main/CONTRIBUTING.md#paperwork-for-pull-requests))
- [ ] provided a link to the relevant issue or specification
- [ ] included the necessary unit and integration [tests](https://github.com/akash-network/blob/main/CONTRIBUTING.md#testing)
- [ ] added a changelog entry to `CHANGELOG.md`
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE/other.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ are the most critical to review. -->

### 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.*
_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...

- [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/akash-network/node/blob/main/CONTRIBUTING.md#paperwork-for-pull-requests))
- [ ] targeted the correct branch (see [PR Targeting](https://github.com/spheronFdn/akash-node/blob/main/CONTRIBUTING.md#paperwork-for-pull-requests))
- [ ] provided a link to the relevant issue or specification
- [ ] reviewed "Files changed" and left comments if necessary
- [ ] confirmed all CI checks have passed
7 changes: 3 additions & 4 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!--
Guiding Principles:
Expand Down Expand Up @@ -38,12 +37,12 @@ Ref: https://keepachangelog.com/en/1.0.0/

## [Unreleased]

* (ibc-go) Use ibc v4.4.0 https://github.com/akash-network/node/pull/1825
- (ibc-go) Use ibc v4.4.0 https://github.com/spheronFdn/akash-node/pull/1825

### Improvements

* (sdk) Bump Cosmos SDK version to [v0.38.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.38.3)
- (sdk) Bump Cosmos SDK version to [v0.38.3](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.38.3)

### Bug Fixes

* Fix bug in ditribution and querying rewards
- Fix bug in ditribution and querying rewards
157 changes: 79 additions & 78 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,25 +10,25 @@ The [Discourse forum](https://forum.akash.network/) is the best place to keep up

There are a number of areas where contributions can be accepted:

* Write Golang code for the CLI, Akash Node (tendermint) and Akash Provider Manager (Kubernetes)
* Write features for the front-end UI (JS, HTML, CSS)
* Write sample functions in any language
* Review pull requests
* Test out new features or work-in-progress
* Get involved in design reviews, request-for-comments (RFCs) and technical proof-of-concepts (PoCs)
* Help release and package Akash including the helm chart, compose files, `kubectl` YAML, marketplaces and stores
* Manage, triage and research Issues and Pull Requests
* Engage with the growing community by providing technical support on Slack/GitHub
* Create docs, guides and write blogs
* Speak at meet-ups, conferences or by helping folks with Akash [on the Discourse forum](https://forum.akash.network/)
- Write Golang code for the CLI, Akash Node (tendermint) and Akash Provider Manager (Kubernetes)
- Write features for the front-end UI (JS, HTML, CSS)
- Write sample functions in any language
- Review pull requests
- Test out new features or work-in-progress
- Get involved in design reviews, request-for-comments (RFCs) and technical proof-of-concepts (PoCs)
- Help release and package Akash including the helm chart, compose files, `kubectl` YAML, marketplaces and stores
- Manage, triage and research Issues and Pull Requests
- Engage with the growing community by providing technical support on Slack/GitHub
- Create docs, guides and write blogs
- Speak at meet-ups, conferences or by helping folks with Akash [on the Discourse forum](https://forum.akash.network/)

This is just a short list of ideas, if you have other ideas for contributing please make a suggestion.

### I want to contribute on GitHub

#### 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/spheronFdn/akash-node/issues) and we'll fix it as soon as we can.

#### I have a (great) idea

Expand All @@ -40,14 +40,14 @@ Every feature carries a cost - a cost if developed wrong, a cost to carry and ma

What makes a good proposal?

* Brief summary including motivation/context
* Any design changes
* Pros + Cons
* Effort required up front
* Effort required for CI/CD, release, ongoing maintenance
* Migration strategy / backwards-compatibility
* Mock-up screenshots or examples of how the CLI would work
* Clear examples of how to reproduce any issue the proposal is addressing
- Brief summary including motivation/context
- Any design changes
- Pros + Cons
- Effort required up front
- Effort required for CI/CD, release, ongoing maintenance
- Migration strategy / backwards-compatibility
- Mock-up screenshots or examples of how the CLI would work
- Clear examples of how to reproduce any issue the proposal is addressing

Once your proposal receives a `design/approved` label you may go ahead and start work on your Pull Request.

Expand Down Expand Up @@ -85,51 +85,51 @@ If you feel there is an issue with Akash or were unable to get the help you need

#### Setting expectations, support and SLAs

* What kind of support can I expect for free?
- What kind of support can I expect for free?

If you are using one of the Open Source projects within the akash repository, then help is offered on a good-will basis by volunteers. You can also request help from employees of Overclock Labs, Inc who host the Akash testnet.
If you are using one of the Open Source projects within the akash repository, then help is offered on a good-will basis by volunteers. You can also request help from employees of Overclock Labs, Inc who host the Akash testnet.

Please be respectful of volunteer time, it is often limited to evenings and weekends. The person you are requesting help from may not reside in your timezone.
Please be respectful of volunteer time, it is often limited to evenings and weekends. The person you are requesting help from may not reside in your timezone.

The Akash chat is the best place to ask questions, suggest features, and to get help. The GitHub issue tracker can be used for suspected issues with the codebase or deployment artifacts.
The Akash chat is the best place to ask questions, suggest features, and to get help. The GitHub issue tracker can be used for suspected issues with the codebase or deployment artifacts.

* What is the SLA for my Issue?
- What is the SLA for my Issue?

Issues are examined, triaged and answered on a best effort basis by volunteers and community contributors. This means that you may receive an initial response within any time period such as: 1 minute, 1 hour, 1 day, or 1 week. There is no implicit meaning to the time between you raising an issue and it being answered or resolved.
Issues are examined, triaged and answered on a best effort basis by volunteers and community contributors. This means that you may receive an initial response within any time period such as: 1 minute, 1 hour, 1 day, or 1 week. There is no implicit meaning to the time between you raising an issue and it being answered or resolved.

If you see an issue which does not have a response or does not have a resolution, it does not mean that it is not important, or that it is being ignored. It simply means it has not been worked on by a volunteer yet.
If you see an issue which does not have a response or does not have a resolution, it does not mean that it is not important, or that it is being ignored. It simply means it has not been worked on by a volunteer yet.

Please take responsibility for following up on your Issues if you feel further action is required.
Please take responsibility for following up on your Issues if you feel further action is required.

* What is the SLA for my Pull Request?
- What is the SLA for my Pull Request?

In a similar way to Issues, Pull Requests are triaged, reviewed, and considered by a team of volunteers - the Core Team, Members Team and the Project Lead. There are dozens of components that make up the Akash project and a limited amount of people. Sometimes PRs may become blocked or require further action.
In a similar way to Issues, Pull Requests are triaged, reviewed, and considered by a team of volunteers - the Core Team, Members Team and the Project Lead. There are dozens of components that make up the Akash project and a limited amount of people. Sometimes PRs may become blocked or require further action.

Please take responsibility for following up on your Pull Requests if you feel further action is required.
Please take responsibility for following up on your Pull Requests if you feel further action is required.

* Why may your PR be delayed?
- Why may your PR be delayed?

* The contributing guide was not followed in some way
- The contributing guide was not followed in some way

* The commits are not signed-off
- The commits are not signed-off

* The commits need to be rebased
- The commits need to be rebased

* Changes have been requested
- Changes have been requested

More information, a use-case, or context may be required for the change to be accepted.
More information, a use-case, or context may be required for the change to be accepted.

* What if I need more than that?
- What if I need more than that?

If you're a company using any of these projects, you can get the following through a support agreement with Overclock Labs, Inc so that the time can be paid for to help your business.
If you're a company using any of these projects, you can get the following through a support agreement with Overclock Labs, Inc so that the time can be paid for to help your business.

A support agreement can be tailored to your needs, you may benefit from support, if you need any of the following:
A support agreement can be tailored to your needs, you may benefit from support, if you need any of the following:

* responses within N hours/days on issues/PRs
* feature prioritization
* urgent help
* 1:1 consultations
* or any other level of professional services
- responses within N hours/days on issues/PRs
- feature prioritization
- urgent help
- 1:1 consultations
- or any other level of professional services

#### I need to add a dependency

Expand All @@ -141,11 +141,11 @@ The chosen tool for vendoring code in the project is [dep](https://github.com/go
### How are releases made?

Releases are made by the *Project Lead* on a regular basis and when deemed necessary. If you want to request a new release then mention this on your PR or Issue.
Releases are made by the _Project Lead_ on a regular basis and when deemed necessary. If you want to request a new release then mention this on your PR or Issue.

Releases are cut with `git` tags and a successful Travis build results in new binary artifacts and Docker images being published to the Docker Hub and Quay.io. See the "Build" badge on each GitHub README file for more.

How are credentials managed for quay.io and the Docker Hub? These credentials are maintained by the *Project Lead*.
How are credentials managed for quay.io and the Docker Hub? These credentials are maintained by the _Project Lead_.

## Governance

Expand All @@ -157,23 +157,23 @@ Akash Network &trade; is a registered trademark of Overclock Labs.

#### Project Lead

Responsibility for the project starts with the *Project Lead*, who delegates specific responsibilities and the corresponding authority to the Core and Members team.
Responsibility for the project starts with the _Project Lead_, who delegates specific responsibilities and the corresponding authority to the Core and Members team.

Some duties include:

* Setting overall technical & community leadership
* Engaging end-user community to advocate needs of end-users and to capture case-studies
* Defining and curating roadmap for Akash Network
* Building a community and team of contributors
* Community & media briefings, out-bound communications, partnerships, relationship management and events
- Setting overall technical & community leadership
- Engaging end-user community to advocate needs of end-users and to capture case-studies
- Defining and curating roadmap for Akash Network
- Building a community and team of contributors
- Community & media briefings, out-bound communications, partnerships, relationship management and events

### How do I become a maintainer?

In the Akash community there are three levels of structure or maintainership:

* Core Team (GitHub org)
* Members Team (GitHub org)
* The rest of the community.
- Core Team (GitHub org)
- Members Team (GitHub org)
- The rest of the community.

#### Core Team

Expand All @@ -186,45 +186,47 @@ The Core Team includes:

The Core Team have the ear of the Project Lead. They help with strategy, project maintenance, community management, and make a regular commitment of time to the project on a weekly basis. The Core Team will usually be responsible for, or be a subject-matter-expert (SME) for a sub-system of Akash Network. Core Team may be granted write (push) access to one or more sub-systems.

The Core Team gain access to a private *core* channel and are required to participate on a regular basis.
The Core Team gain access to a private _core_ channel and are required to participate on a regular basis.

The Core Team have the same expectations and perks of the Membership Team, in addition will need to keep in close contact with the rest of the Core Team and the Project Lead.

* Core Team are expected to attend 1:1 video conferencing calls with the Project Lead up to once per week
* Core Team members will notify the Project Lead and Core Team of any leave of a week or more and set a status in Slack of "away".
- Core Team are expected to attend 1:1 video conferencing calls with the Project Lead up to once per week
- Core Team members will notify the Project Lead and Core Team of any leave of a week or more and set a status in Slack of "away".

Core Team attend all project meetings and calls. Allowances will be made for timezones and other commitments.

#### Members Team

The Members Team are contributors who are well-known to the community with a track record of:

* fixing, testing and triaging issues and PRs
* offering support to the project
* providing feedback and being available to help where needed
* testing and reviewing pull requests
* joining contributor meetings and supporting new contributors
- fixing, testing and triaging issues and PRs
- offering support to the project
- providing feedback and being available to help where needed
- testing and reviewing pull requests
- joining contributor meetings and supporting new contributors

> Note: An essential skill for being in a team is communication. If you cannot communicate with your team on a regular basis, then membership may not be for you and you are welcome to contribute as community.
Members Team Perks:
* access to a private Slack channel
* profile posted on the Team page of the Akash website
* membership of the GitHub organizations Akash-Network

- access to a private Slack channel
- profile posted on the Team page of the Akash website
- membership of the GitHub organizations Akash-Network

Upon request and subject to availability:
* 1:1 coaching & mentorship
* help with speaking opportunities and CfP submissions
* help with CV, resume and LinkedIn profile
* review, and promotion of blogs and tutorials on social media

- 1:1 coaching & mentorship
- help with speaking opportunities and CfP submissions
- help with CV, resume and LinkedIn profile
- review, and promotion of blogs and tutorials on social media

The Members Team are expected to:

* participate in the members channel and engage with the topics
* participate in community Zoom calls (when possible within your timezone)
* make regular contributions to the project codebase
* comment on and engage with project proposals
* attend occasional 1:1 meetings with members of the Core Team or the Project Lead
- participate in the members channel and engage with the topics
- participate in community Zoom calls (when possible within your timezone)
- make regular contributions to the project codebase
- comment on and engage with project proposals
- attend occasional 1:1 meetings with members of the Core Team or the Project Lead

This group is intended to be an active team that shares the load and collaborates together. This means engaging in topics on Chat, encouraging other teammates, sharing ideas, helping the users and raising issues with the Core Team.

Expand Down Expand Up @@ -257,10 +259,9 @@ There is a forum which you are welcome to join to discuss Akash Network, Kuberne

[Join Discord here](https://discord.com/invite/DxftX67)


### Roadmap

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

## License

Expand Down
Loading

0 comments on commit b185eda

Please sign in to comment.