mirror
/
gomatrix
mirror of https://github.com/matrix-org/gomatrix
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix formatting

This commit is contained in:
northernSage 2021-02-25 07:25:59 -03:00
parent 049d2d9eda
commit fffd6ae426
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -28,48 +28,45 @@ If you intend to contribute to gomatrix you'll first need Go installed on your m
- Fork gomatrix to your GitHub account by clicking the [Fork](https://github.com/matrix-org/gomatrix/fork) button. - Fork gomatrix to your GitHub account by clicking the [Fork](https://github.com/matrix-org/gomatrix/fork) button.
- [Clone](https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork) the main repository (not your fork) to your local machine. - [Clone](https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork) the main repository (not your fork) to your local machine.
```
$ git clone https://github.com/matrix-org/gomatrix $ git clone https://github.com/matrix-org/gomatrix
$ cd gomatrix $ cd gomatrix
```
- Add your fork as a remote to push your contributions.Replace - Add your fork as a remote to push your contributions.Replace
``{username}`` with your username. ``{username}`` with your username.
`git remote add fork https://github.com/{username}/gomatrix` git remote add fork https://github.com/{username}/gomatrix
- Create a new branch to identify what feature you are working on. - Create a new branch to identify what feature you are working on.
```
$ git fetch origin $ git fetch origin
$ git checkout -b your-branch-name origin/master $ git checkout -b your-branch-name origin/master
```
- Make your changes, including tests that cover any code changes you make, and run them as described below. - Make your changes, including tests that cover any code changes you make, and run them as described below.
- Execute pre-commit hooks by running - Execute pre-commit hooks by running
`<gomatrix dir>/hooks/pre-commit` <gomatrix dir>/hooks/pre-commit
- Push your changes to your fork and [create a pull request](https://help.github.com/en/articles/creating-a-pull-request) describing your changes. - Push your changes to your fork and [create a pull request](https://help.github.com/en/articles/creating-a-pull-request) describing your changes.
`$ git push --set-upstream fork your-branch-name` $ git push --set-upstream fork your-branch-name
- Finally, create a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) - Finally, create a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
## How to run tests ## How to run tests
You can run the test suite and example code with You can run the test suite and example code with `$ go test -v`
`$ go test -v`
# Running Coverage # Running Coverage
To run coverage, first generate the coverage report using `go test` To run coverage, first generate the coverage report using `go test`
`go test -v -cover -coverprofile=coverage.out` go test -v -cover -coverprofile=coverage.out
You can now show the generated report as a html page with `go tool` You can now show the generated report as a html page with `go tool`
`go tool cover -html=coverage.out` go tool cover -html=coverage.out