From b9119bcd81fcdd0de4f89e6a4e184c60b8dcf236 Mon Sep 17 00:00:00 2001 From: Myron Rotter Date: Tue, 12 Nov 2024 08:34:43 +0700 Subject: [PATCH 1/2] fix: typos; chore: documentation to test project adapters --- .../{group-approvals.yml => enforce-approvals.yml} | 0 .github/workflows/go-fmt.yml | 2 +- .github/workflows/go-test.yml | 2 +- README.md | 10 +++++++--- 4 files changed, 9 insertions(+), 5 deletions(-) rename .github/workflows/{group-approvals.yml => enforce-approvals.yml} (100%) diff --git a/.github/workflows/group-approvals.yml b/.github/workflows/enforce-approvals.yml similarity index 100% rename from .github/workflows/group-approvals.yml rename to .github/workflows/enforce-approvals.yml diff --git a/.github/workflows/go-fmt.yml b/.github/workflows/go-fmt.yml index b7e5e44..fd691ce 100644 --- a/.github/workflows/go-fmt.yml +++ b/.github/workflows/go-fmt.yml @@ -6,7 +6,7 @@ on: - main jobs: - go-famt: + go-fmt: runs-on: ubuntu-latest steps: diff --git a/.github/workflows/go-test.yml b/.github/workflows/go-test.yml index b8cfe18..6911612 100644 --- a/.github/workflows/go-test.yml +++ b/.github/workflows/go-test.yml @@ -6,7 +6,7 @@ on: - main jobs: - test: + go-test: runs-on: ubuntu-latest steps: diff --git a/README.md b/README.md index 35fc6ad..d89fe00 100644 --- a/README.md +++ b/README.md @@ -39,16 +39,20 @@ After the details of the indexer has been confirmed with the team, add your proj ### 2. Write your Indexer -An example adapter for tracking OrderFulfilled Event on the OKX marketplace can be seen [here](./projects/okx/order_fulfilled.go) along with its accompanying test file. +An example adapter for tracking OrderFulfilled Event on the OKX marketplace can be seen [here](./adapters/projects/okx/order_fulfilled.go) along with its accompanying test file. ### 3. Manually Test your Adapter by adding it to the CLI First, add a new adapter in `cmd/adapter.go`. Second, add adapter to switch case of `cmd/cmd.go`'s function `executeCommand`. Test out the CLI with `go run .` from project root. -### 4. Create a Pull Request +### 4. Add a Test to your Indexer + +Add atleast one test case to your project's adapter. For an example, see [here](./adapters/projects/okx/order_fulfilled_test.go). + +### 5. Create a Pull Request Create a pull request (PR) on GitHub to merge your changes into the main branch. Provide a clear description of the changes and the protocol added. -### 5. Review and Merge +### 6. Review and Merge Wait for the PR to be reviewed by the maintainers. Once approved, your changes will be merged, and the protocol info will be added to trailblazers. From 625a785f408dacd04ff611a2f5fde91808fc69a7 Mon Sep 17 00:00:00 2001 From: Myron Rotter Date: Sun, 17 Nov 2024 09:38:30 +0700 Subject: [PATCH 2/2] fix: typo Co-authored-by: Bennett Yong <36499389+bennettyong@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d89fe00..4de2ed7 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ First, add a new adapter in `cmd/adapter.go`. Second, add adapter to switch case ### 4. Add a Test to your Indexer -Add atleast one test case to your project's adapter. For an example, see [here](./adapters/projects/okx/order_fulfilled_test.go). +Add at least one test case to your project's adapter. For an example, see [here](./adapters/projects/okx/order_fulfilled_test.go). ### 5. Create a Pull Request