-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* fix: re-brand lfb to lbm * chore: to do github action * fix: update changelog
- Loading branch information
Woosang Son
authored
Sep 13, 2021
1 parent
f6c9deb
commit e857567
Showing
58 changed files
with
854 additions
and
853 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
repositoryUrl: [email protected]:line/lfb.git | ||
repositoryUrl: [email protected]:line/lbm.git | ||
verifyConditions: ['@semantic-release/github'] | ||
prepare: [] | ||
publish: ['@semantic-release/github'] | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,13 @@ | ||
# How to contribute to LFB | ||
# How to contribute to LBM | ||
|
||
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/lfb/issues) to report bugs and propose new features and | ||
- File an issue in [the issue tracker](https://github.com/line/lbm/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/lfb/issues). | ||
- Browse [the list of previously answered questions](https://github.com/line/lfb/issues?q=label%3Aquestion). | ||
- Contribute your work by sending [a pull request](https://github.com/line/lfb/pulls). | ||
- 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). | ||
|
||
## 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/lfb/blob/main/CODE_OF_CONDUCT.md). | ||
We expect contributors to follow [our code of conduct](https://github.com/line/lbm/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/lfb`, | ||
the code should never exist at `$GOPATH/src/github.com/someone/lfb`. | ||
While my fork lives at `https://github.com/someone/lbm`, | ||
the code should never exist at `$GOPATH/src/github.com/someone/lbm`. | ||
Instead, we use `git remote` to add the fork as a new remote for the original repo, | ||
`$GOPATH/src/github.com/line/lfb`, and do all the work there. | ||
`$GOPATH/src/github.com/line/lbm`, 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/lfb`) | ||
- Go to the original repo checked out locally (i.e. `$GOPATH/src/github.com/line/lbm`) | ||
- `git remote rename origin upstream` | ||
- `git remote add origin [email protected]:someone/lfb.git` | ||
- `git remote add origin [email protected]:someone/lbm.git` | ||
|
||
Now `origin` refers to my fork and `upstream` refers to the lfb version. | ||
So I can `git push -u origin main` to update my fork, and make pull requests to lfb from there. | ||
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. | ||
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.15 Modules](https://github.com/golang/go/wiki/Modules) to manage | ||
dependency versions. | ||
|
||
The `main` branch of every LFB repository should just build with `go get`, | ||
The `main` branch of every LBM 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 lfb repository. | ||
Tests can be ran by running `make test` at the top level of the lbm repository. | ||
|
||
We expect tests to use `require` or `assert` rather than `t.Skip` or `t.Fail`, | ||
unless there is a reason to do otherwise. | ||
|
@@ -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/lfb, or your fork (using `git remote add origin`) | ||
- create a development branch either on github.com/line/lbm, or your fork (using `git remote add origin`) | ||
- before submitting a pull request, begin `git rebase` on top of `main` | ||
### Pull Merge Procedure | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.