From cc00ddf2b5ee13924ad9cea844da744f60ad096a Mon Sep 17 00:00:00 2001 From: zemyblue Date: Mon, 27 Mar 2023 15:13:22 +0900 Subject: [PATCH 1/7] doc: change the word `lbm` to `finschia` in CONTRIBUTING.md. Signed-off-by: zemyblue --- CONTRIBUTING.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea91b93c..07aed974 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,13 @@ -# How to contribute to LBM +# How to contribute to Finschia First of all, thank you so much for taking your time to contribute! It will be amazing if you could help us by doing any of the following: -- File an issue in [the issue tracker](https://github.com/line/lbm/issues) to report bugs and propose new features and +- File an issue in [the issue tracker](https://github.com/line/finschia/issues) to report bugs and propose new features and improvements. -- Ask a question by creating a new issue in [the issue tracker](https://github.com/line/lbm/issues). - - Browse [the list of previously answered questions](https://github.com/line/lbm/issues?q=label%3Aquestion). -- Contribute your work by sending [a pull request](https://github.com/line/lbm/pulls). +- Ask a question by creating a new issue in [the issue tracker](https://github.com/line/finschia/issues). + - Browse [the list of previously answered questions](https://github.com/line/finschia/issues?q=label%3Aquestion). +- Contribute your work by sending [a pull request](https://github.com/line/finschia/pulls). ## Contributor license agreement @@ -17,7 +17,7 @@ the ICLA (individual contributor license agreement). Please ## Code of conduct -We expect contributors to follow [our code of conduct](https://github.com/line/lbm/blob/main/CODE_OF_CONDUCT.md). +We expect contributors to follow [our code of conduct](https://github.com/line/finschia/blob/main/CODE_OF_CONDUCT.md). ## Commit message and Pull Request message @@ -49,20 +49,20 @@ All PRs require two Reviews before merge (except docs changes, or variable name- ## Forking Please note that Go requires code to live under absolute paths, which complicates forking. -While my fork lives at `https://github.com/someone/lbm`, -the code should never exist at `$GOPATH/src/github.com/someone/lbm`. +While my fork lives at `https://github.com/someone/finschia`, +the code should never exist at `$GOPATH/src/github.com/someone/finschia`. Instead, we use `git remote` to add the fork as a new remote for the original repo, -`$GOPATH/src/github.com/line/lbm`, and do all the work there. +`$GOPATH/src/github.com/line/finschia`, and do all the work there. For instance, to create a fork and work on a branch of it, I would: - Create the fork on github, using the fork button. -- Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/line/lbm`) +- Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/line/finschia`) - `git remote rename origin upstream` -- `git remote add origin git@github.com:someone/lbm.git` +- `git remote add origin git@github.com:someone/finschia.git` -Now `origin` refers to my fork and `upstream` refers to the lbm version. -So I can `git push -u origin main` to update my fork, and make pull requests to lbm from there. +Now `origin` refers to my fork and `upstream` refers to the finschia version. +So I can `git push -u origin main` to update my fork, and make pull requests to finschia from there. Of course, replace `someone` with your git handle. To pull in updates from the origin repo, run @@ -77,7 +77,7 @@ Please don't make Pull Requests from `main`. We use [Go 1.18 Modules](https://github.com/golang/go/wiki/Modules) to manage dependency versions. -The `main` branch of every LBM repository should just build with `go get`, +The `main` branch of every finschia repository should just build with `go get`, which means they should be kept up-to-date with their dependencies, so we can get away with telling people they can just `go get` our software. @@ -86,7 +86,7 @@ build, in which case we can fall back on `go mod tidy -v`. ## Testing -Tests can be ran by running `make test` at the top level of the lbm repository. +Tests can be ran by running `make test` at the top level of the finschia repository. We expect tests to use `require` or `assert` rather than `t.Skip` or `t.Fail`, unless there is a reason to do otherwise. @@ -94,7 +94,7 @@ When testing a function under a variety of different inputs, we prefer to use [table driven tests](https://github.com/golang/go/wiki/TableDrivenTests). Table driven test error messages should follow the following format `, tc #, i #`. -`` is an optional short description of whats failing, `tc` is the +`` is an optional short description of what failing, `tc` is the index within the table of the testcase that is failing, and `i` is when there is a loop, exactly which iteration of the loop failed. The idea is you should be able to see the @@ -132,7 +132,7 @@ should be targeted against the release candidate branch. - `main` must never fail `make lint test test-race` - `main` should not fail `make lint` - no `--force` onto `main` (except when reverting a broken commit, which should seldom happen) -- create a development branch either on github.com/line/lbm, or your fork (using `git remote add origin`) +- create a development branch either on github.com/line/finschia, or your fork (using `git remote add origin`) - before submitting a pull request, begin `git rebase` on top of `main` ### Pull Merge Procedure From 586b85081ef65f19ee8dbdbad8a176fa6b426636 Mon Sep 17 00:00:00 2001 From: zemyblue Date: Mon, 27 Mar 2023 17:45:57 +0900 Subject: [PATCH 2/7] doc: remove unnecessary private token guide in README.md Signed-off-by: zemyblue --- README.md | 37 ++++++++++++------------------------- 1 file changed, 12 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index a4aed780..d0a9930d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # Finschia [![codecov](https://codecov.io/gh/line/lbm/branch/main/graph/badge.svg?token=JFFuUevpzJ)](https://codecov.io/gh/line/lbm) +[![license](https://img.shields.io/github/license/line/finschia.svg)](https://github.com/line/finschia/blob/main/LICENSE) +[![LoC](https://tokei.rs/b1/github/line/finschia)](https://github.com/line/finschia) +[![Go Report Card](https://goreportcard.com/badge/github.com/line/finschia)](https://goreportcard.com/report/github.com/line/finschia) +[![GolangCI](https://golangci.com/badges/github.com/line/finschia.svg)](https://golangci.com/r/github.com/line/finschia) + This repository hosts `Finschia`. This repository is forked from [gaia](https://github.com/cosmos/gaia) at 2021-03-15. Finschia is a mainnet app implementation using [lbm-sdk](https://github.com/line/lbm-sdk), [ostracon](https://github.com/line/ostracon), [wasmd](https://github.com/line/wasmd) and [ibc-go](https://github.com/line/ibc-go). @@ -13,7 +18,7 @@ This repository hosts `Finschia`. This repository is forked from [gaia](https:// ## Docker **Build Docker Image** ``` -make build-docker GITHUB_TOKEN=${YOUR_GITHUB_TOKEN} # build docker image +make build-docker # build docker image ``` or ``` @@ -31,32 +36,10 @@ sh init_single.sh docker testnet # prepare keys, validators, initial state, etc **Run** ``` -docker run -i -p 26656:26656 -p 26657:26657 -v ${HOME}/.finschia:/root/.finschia line/lbm lbm start +docker run -i -p 26656:26656 -p 26657:26657 -v ${HOME}/.finschia:/root/.finschia line/lbm fnsad start ``` ## Local -**Set up permissions** -``` -go env -w GOPRIVATE="github.com/line/*" -git config --global url."https://${YOUR_GITHUB_TOKEN}:x-oauth-basic@github.com/".insteadOf "https://github.com/" -``` - -_Note1_ - -You have to replace ${YOUR_GITHUB_TOKEN} with your token. - -To create a token, -see: https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token - -_Note2_ - -Please check `GOPRIVATE` is set by run export and check the result. -``` -go env -``` -if you can see `GOPRIVATE`, then you're good to go. - -Otherwise you need to set `GOPRIVATE` as environment variable. **Build** ``` @@ -75,7 +58,7 @@ sh init_single.sh testnet # for testnet **Run** ``` -lbm start # Run a node +fnsad start # Run a node ``` **visit with your browser** @@ -93,3 +76,7 @@ make localnet-start make localnet-stop ``` + +# How to contribute +check out [CONTRIBUTING.md](CONTRIBUTING.md) for our guidelines & policies for how we develop Finschia. Thank you to all those who have contributed! + From 0ab180dd59d5eb76357d4560cf116a0fec3ed2a3 Mon Sep 17 00:00:00 2001 From: zemyblue Date: Mon, 27 Mar 2023 18:46:56 +0900 Subject: [PATCH 3/7] doc: remove broken links. Signed-off-by: zemyblue --- docs/README.md | 1 - docs/finschia-tutorials/README.md | 3 --- docs/finschia-tutorials/what-is-finschia.md | 3 +-- docs/resources/README.md | 3 --- docs/validators/README.md | 3 --- 5 files changed, 1 insertion(+), 12 deletions(-) diff --git a/docs/README.md b/docs/README.md index d2a0f849..b784c56b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -15,7 +15,6 @@ Welcome to the documentation of the **Finschia Mainnet**. ## Join the Finschia Mainnet - [Install the `fnsad` application](finschia-tutorials/installation.md) -- [Set up a full node and join the mainnet](finschia-tutorials/join-mainnet.md) - [Upgrade to a validator node](./validators/validator-setup.md) ## Setup Your Own `Finschia` Testnet diff --git a/docs/finschia-tutorials/README.md b/docs/finschia-tutorials/README.md index 75ef0e54..c1e2f09e 100644 --- a/docs/finschia-tutorials/README.md +++ b/docs/finschia-tutorials/README.md @@ -10,7 +10,4 @@ This folder contains tutorials related to the `Finschia` application. - [Introduction to the `Finschia` application](./what-is-finschia.md) - [Installing `Finschia`](./installation.md) -- [Running a full-node for a Finschia Mainnet](./join-mainnet.md) -- [Running a full-node for a `Finschia` testnet](./join-testnet.md) -- [Upgrading a Node from a previous version](./upgrade-node.md) - [Deploying a `Finschia` testnet](./deploy-testnet.md) \ No newline at end of file diff --git a/docs/finschia-tutorials/what-is-finschia.md b/docs/finschia-tutorials/what-is-finschia.md index 95baa6a6..86bffc1b 100644 --- a/docs/finschia-tutorials/what-is-finschia.md +++ b/docs/finschia-tutorials/what-is-finschia.md @@ -8,7 +8,7 @@ order: 1 - `fnsad`: The Finschia Daemon and command-line interface (CLI). runs a full-node of the `fnsad` application. -`fnsad` is built on the LBM SDK using the following modules: +`fnsad` is built on `x/wasm` module of WASMD, `x/ibc` module of IBC-GO and the LBM SDK using the following modules: - `x/auth`: Accounts and signatures. - `x/bank`: Token transfers. @@ -17,7 +17,6 @@ order: 1 - `x/distribution`: Fee distribution logic. - `x/slashing`: Slashing logic. - `x/gov`: Governance logic. -- `x/ibc`: Inter-blockchain transfers. - `x/params`: Handles app-level parameters. About a Finschia Mainnet: A Finschia Mainnet is a blockchain mainnet network using Finschia. Any Finschia Mainnet can connect to each other via IBC, it automatically gains access to all the other blockchains that are connected to it. A Finschia Mainnet is a public Proof-of-Stake chain. Its staking token is called the Link. diff --git a/docs/resources/README.md b/docs/resources/README.md index 5f622c24..c8df8f33 100644 --- a/docs/resources/README.md +++ b/docs/resources/README.md @@ -11,6 +11,3 @@ This folder contains resources on the `fnsad` software. - [`fnsad` documentation](./finschia.md) - [`fnsad` genesis file](./genesis.md) - [HD Wallets for `fnsad`](./hd-wallets.md) -- [Ledger Integration for `fnsad`](./ledger.md) -- [Service Providers Documentation](./service-providers.md) -- [Reproducible Builds](./reproducible-builds.md) diff --git a/docs/validators/README.md b/docs/validators/README.md index 6f82af18..6ab3dc8a 100644 --- a/docs/validators/README.md +++ b/docs/validators/README.md @@ -11,6 +11,3 @@ This folder contains documentation relevant to validators of a Finschia Mainnet. - [Validator Overview](./overview.md) - [Setting Up a Validator for Finschia Mainnet](./validator-setup.md) - [Validator Security Notice](./security.md) -- Key Management System - + [Intro to KMS](./kms/kms.md) - + [KMS + Ledger](./kms/kms_ledger.md) \ No newline at end of file From e0ccbef43af0219c85e435acf490af0949494f33 Mon Sep 17 00:00:00 2001 From: zemyblue Date: Mon, 27 Mar 2023 18:59:58 +0900 Subject: [PATCH 4/7] doc: add issue template and pr template Signed-off-by: zemyblue --- .github/ISSUE_TEMPLATE/bug-report.md | 28 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature-request.md | 32 +++++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 25 ++++++++++++++++++ 3 files changed, 85 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 00000000..25f4eea8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,28 @@ +--- +name: Bug Report +about: Create a report to help us squash bugs! +--- + + + +## Summary of Bug + + +## Version + + +## Steps to Reproduce + + +____ + +## For Admin Use + +- [ ] Not duplicate issue +- [ ] Appropriate labels applied +- [ ] Appropriate contributors tagged +- [ ] Contributor assigned/self-assigned diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md new file mode 100644 index 00000000..0c05d846 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -0,0 +1,32 @@ +--- +name: Feature Request +about: Create a proposal to request a feature +--- + + + +## Summary + + +## Problem Definition + + +## Proposal + + +____ + +#### For Admin Use + +- [ ] Not duplicate issue +- [ ] Appropriate labels applied +- [ ] Appropriate contributors tagged +- [ ] Contributor assigned/self-assigned diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..9a0554ab --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ + + +## Description + +closes: #XXXX + +## Motivation and context + + + +## How has this been tested? + + + + +## Screenshots (if appropriate): + +## Checklist: + + + +- [ ] I followed the [contributing guidelines](https://github.com/line/finschia/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/line/finschia/blob/main/CODE_OF_CONDUCT.md). +- [ ] I have added a relevant changelog to `CHANGELOG.md` +- [ ] I have added tests to cover my changes. +- [ ] I have updated the documentation accordingly. From a1cc01ac07917ad8d475a16cbba95b164e3d9b5f Mon Sep 17 00:00:00 2001 From: zemyblue Date: Mon, 27 Mar 2023 19:11:24 +0900 Subject: [PATCH 5/7] chore: update changelog Signed-off-by: zemyblue --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 903e4377..01801ff8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -60,6 +60,8 @@ Ref: https://keepachangelog.com/en/1.0.0/ ### Build, CI (ci) [\#145](https://github.com/line/lbm/pull/145) add github action to push docker image to docker.io +### Docs +* (doc) [\#156](https://github.com/line/finschia/pull/156) modify broken link or typo doc file and add issue and pr template [Unreleased]: https://github.com/line/lbm/compare/v0.7.0...HEAD From bdbc4cdf60c51293c446d0504397bf7f35f49acb Mon Sep 17 00:00:00 2001 From: zemyblue Date: Tue, 28 Mar 2023 12:06:37 +0900 Subject: [PATCH 6/7] doc: change contact email address Signed-off-by: zemyblue --- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 198dd6e4..39300de9 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -61,7 +61,7 @@ representative at an online or offline event. Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at -[dl_oss_dev@linecorp.com](mailto:dl_oss_dev@linecorp.com). +[dev@finschia.org](mailto:dev@finschia.org). All complaints will be reviewed and investigated promptly and fairly. All community leaders are obligated to respect the privacy and security of the diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 07aed974..78ae2f96 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ It will be amazing if you could help us by doing any of the following: When you are sending a pull request and it's a non-trivial change beyond fixing typos, please sign the ICLA (individual contributor license agreement). Please -[contact us](mailto:dl_oss_dev@linecorp.com) if you need the CCLA (corporate contributor license agreement). +[contact us](mailto:dev@finschia.org) if you need the CCLA (corporate contributor license agreement). ## Code of conduct From fb9fc8ccbb725c7c982cf47917da31c473002938 Mon Sep 17 00:00:00 2001 From: zemyblue Date: Tue, 28 Mar 2023 17:41:24 +0900 Subject: [PATCH 7/7] Update CONTRIBUTING.md Co-authored-by: Youngtaek Yoon --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 78ae2f96..79b5a3f9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,7 +94,7 @@ When testing a function under a variety of different inputs, we prefer to use [table driven tests](https://github.com/golang/go/wiki/TableDrivenTests). Table driven test error messages should follow the following format `, tc #, i #`. -`` is an optional short description of what failing, `tc` is the +`` is an optional short description of what's failing, `tc` is the index within the table of the testcase that is failing, and `i` is when there is a loop, exactly which iteration of the loop failed. The idea is you should be able to see the