Skip to content
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.

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

Modify several docs #156

Merged
merged 7 commits into from
Mar 29, 2023
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
name: Bug Report
about: Create a report to help us squash bugs!
---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
v Before smashing the submit button please review the template
v Please also ensure that this is not a duplicate issue :)
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Summary of Bug
<!-- Concisely describe the issue -->

## Version
<!-- git commit hash or release version -->

## Steps to Reproduce
<!-- What commands in order should someone run to reproduce your problem? -->

____

## For Admin Use

- [ ] Not duplicate issue
- [ ] Appropriate labels applied
- [ ] Appropriate contributors tagged
- [ ] Contributor assigned/self-assigned
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Feature Request
about: Create a proposal to request a feature
---

<!-- < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < ☺
v ✰ Thanks for opening an issue! ✰
v Before smashing the submit button please review the template.
v Word of caution: poorly thought-out proposals may be rejected
v without deliberation
☺ > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > -->

## Summary
<!-- Short, concise description of the proposed feature -->

## Problem Definition
<!-- Why do we need this feature?
What problems may be addressed by introducing this feature?
What benefits does the SDK stand to gain by including this feature?
Are there any disadvantages of including this feature? -->

## Proposal
<!-- Detailed description of requirements of implementation -->

____

#### For Admin Use

- [ ] Not duplicate issue
- [ ] Appropriate labels applied
- [ ] Appropriate contributors tagged
- [ ] Contributor assigned/self-assigned
25 changes: 25 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!--- Provide a general summary of your changes in the Title above -->

## Description
<!--- Describe your changes in detail -->
closes: #XXXX

## Motivation and context
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->

## How has this been tested?
<!--- Please describe in detail how you tested your changes. -->
<!--- Include details of your testing environment, and the tests you ran to -->
<!--- see how your change affects other areas of the code, etc. -->

## Screenshots (if appropriate):

## Checklist:
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If any of the checklist items are not applicable, leave it `[ ]` and write a little note why. --->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
- [ ] 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.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<!-- Release links -->
[Unreleased]: https://github.com/line/lbm/compare/v0.7.0...HEAD
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
36 changes: 18 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# 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

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

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

Expand Down Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -86,15 +86,15 @@ 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.
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
`<desc>, tc #<index>, i #<index>`.
`<desc>` is an optional short description of whats failing, `tc` is the
`<desc>` is an optional short description of what failing, `tc` is the
zemyblue marked this conversation as resolved.
Show resolved Hide resolved
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
Expand Down Expand Up @@ -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
Expand Down
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).

Expand All @@ -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
```
Expand All @@ -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
zemyblue marked this conversation as resolved.
Show resolved Hide resolved
```

## 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**
```
Expand All @@ -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**
Expand All @@ -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!

1 change: 0 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions docs/finschia-tutorials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 1 addition & 2 deletions docs/finschia-tutorials/what-is-finschia.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
zemyblue marked this conversation as resolved.
Show resolved Hide resolved

- `x/auth`: Accounts and signatures.
- `x/bank`: Token transfers.
Expand All @@ -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.
Expand Down
3 changes: 0 additions & 3 deletions docs/resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
3 changes: 0 additions & 3 deletions docs/validators/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)