diff options
author | Wim <wim@42.be> | 2022-03-20 01:43:26 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-03-20 01:43:26 +0100 |
commit | 17da95b094e4bb433e5fe240fa42067d94d908c1 (patch) | |
tree | 50abef4f2d92c1088d3a47c659bbc977a94f96b1 /vendor/github.com/matterbridge/gomatrix/README.md | |
parent | c5e49eec96a8b03786d679afa35c58952d0269a7 (diff) | |
download | matterbridge-msglm-17da95b094e4bb433e5fe240fa42067d94d908c1.tar.gz matterbridge-msglm-17da95b094e4bb433e5fe240fa42067d94d908c1.tar.bz2 matterbridge-msglm-17da95b094e4bb433e5fe240fa42067d94d908c1.zip |
Remove go replace by fork (matrix) (#1771)
Diffstat (limited to 'vendor/github.com/matterbridge/gomatrix/README.md')
-rw-r--r-- | vendor/github.com/matterbridge/gomatrix/README.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/vendor/github.com/matterbridge/gomatrix/README.md b/vendor/github.com/matterbridge/gomatrix/README.md new file mode 100644 index 00000000..a083b46c --- /dev/null +++ b/vendor/github.com/matterbridge/gomatrix/README.md @@ -0,0 +1,71 @@ +# gomatrix +[![GoDoc](https://godoc.org/github.com/matrix-org/gomatrix?status.svg)](https://godoc.org/github.com/matrix-org/gomatrix) + +A Golang Matrix client. + +**THIS IS UNDER ACTIVE DEVELOPMENT: BREAKING CHANGES ARE FREQUENT.** + +# Contributing + +All contributions are greatly appreciated! + +## How to report issues + +Please check the current open issues for similar reports +in order to avoid duplicates. + +Some general guidelines: + +- Include a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) when possible. +- Describe the expected behaviour and what actually happened + including a full trace-back in case of exceptions. +- Make sure to list details about your environment + +## Setting up your environment + +If you intend to contribute to gomatrix you'll first need Go installed on your machine (version 1.12+ is required). Also, make sure to have golangci-lint properly set up since we use it for pre-commit hooks (for instructions on how to install it, check the [official docs](https://golangci-lint.run/usage/install/#local-installation)). + +- 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. + + + $ git clone https://github.com/matrix-org/gomatrix + $ cd gomatrix + + +- Add your fork as a remote to push your contributions.Replace + ``{username}`` with your username. + + git remote add fork https://github.com/{username}/gomatrix + +- Create a new branch to identify what feature you are working on. + + $ git fetch origin + $ 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. + +- Execute pre-commit hooks by running + + <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. + + $ 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) + +## How to run tests + +You can run the test suite and example code with `$ go test -v` + +# Running Coverage + +To run coverage, first generate the coverage report using `go test` + + go test -v -cover -coverprofile=coverage.out + +You can now show the generated report as a html page with `go tool` + + go tool cover -html=coverage.out |