diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 429277ed7..8553584d7 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -33,7 +33,7 @@ Examples of unacceptable behavior include: * Public or private harassment * Publishing others' private information, such as a physical or email address, without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a +* Other conduct that could reasonably be considered inappropriate in a professional setting ## Enforcement Responsibilities diff --git a/README.md b/README.md index b5ddaed2c..321de4df5 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ## Directory Structure
-├── bridge-history-api: Bridge history service that collects deposit and withdraw events from both L1 and L2 chain and generates withdrawal proofs
+├── bridge-history-api: Bridge history service that collects deposit and withdraw events from both L1 and L2 chains and generates withdrawal proofs
 ├── common: Common libraries and types
 ├── coordinator: Prover coordinator service that dispatches proving tasks to provers
 ├── database: Database client and schema definition
diff --git a/bridge-history-api/README.md b/bridge-history-api/README.md
index 27f9bb5a8..8e9044453 100644
--- a/bridge-history-api/README.md
+++ b/bridge-history-api/README.md
@@ -7,7 +7,7 @@ The bridge-history-api contains three distinct components
 
 ### bridgehistoryapi-db-cli
 
-Provide init, show version, rollback, check status services of DB
+Provide init, show version, rollback, and check status services of DB
 ```
     cd ./bridge-history-api
     make bridgehistoryapi-db-cli
@@ -35,11 +35,11 @@ provides REST APIs. Please refer to the API details below.
 ## APIs provided by bridgehistoryapi-server
 
 assume `bridgehistoryapi-server` listening on `https://localhost:8080`
-can change this port thru modify `config.json`
+can change this port by modifying `config.json`
 
 1. `/txs`
 ```
-// @Summary    	 get all txs under given address
+// @Summary    	 get all txs under the given address
 // @Accept       plain
 // @Produce      plain
 // @Param        address query string true "wallet address"
@@ -61,7 +61,7 @@ can change this port thru modify `config.json`
 
 3. `/claimable`
 ```
-// @Summary    	 get all claimable txs under given address
+// @Summary    	 get all claimable txs under the given address
 // @Accept       plain
 // @Produce      plain
 // @Param        address query string true "wallet address"
@@ -79,4 +79,4 @@ can change this port thru modify `config.json`
 // @Param        batch_index  query string  true  "batch_index"
 // @Success      200
 // @Router       /api/withdraw_root [get]
-```
\ No newline at end of file
+```