diff options
author | Brendan Abolivier <babolivier@matrix.org> | 2019-05-22 10:44:25 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-05-22 10:44:25 +0100 |
commit | e1ec98e248ab9cdaa5f648bad871994b7abcabc7 (patch) | |
tree | e0d94b98fe7ee3db1a9eee47240c2402d03be615 /CONTRIBUTING.md | |
parent | 74827428bd3e11faab65f12204449c1b9469b0ae (diff) |
Update Docker files and remove references to gb (#703)
Fix Docker files which had been forgotten in #594 and update scripts and docs to remove references to gb.
I also removed the `jenkins` directory which is outdated. We can revert f8d7e99 if we realise that it was a mistake to do so.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 25 |
1 files changed, 7 insertions, 18 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ef22b7f8..22ad0586 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,11 +12,13 @@ See [INSTALL.md](INSTALL.md) for instructions on setting up a running dev instance of dendrite, and [CODE_STYLE.md](CODE_STYLE.md) for the code style guide. -We use `gb` for managing our dependencies, so `gb build` and `gb test` is how -to build dendrite and run the unit tests respectively. Be aware that a list of -all dendrite packages is the expected output for all tests succeeding with `gb -test`. There are also [scripts](scripts) for [linting](scripts/find-lint.sh) -and doing a [build/test/lint run](scripts/build-test-lint.sh). +As of May 2019, we're not using `gb` anymore, which is the tool we had been +using for managing our dependencies. We're now using Go modules. To build +Dendrite, run the `build.sh` script at the root of this repository (which runs +`go install` under the hood), and to run unit tests, run `go test ./...` (which +should pick up any unit test and run it). There are also [scripts](scripts) for +[linting](scripts/find-lint.sh) and doing a [build/test/lint +run](scripts/build-test-lint.sh). ## Picking Things To Do @@ -33,18 +35,6 @@ nonetheless fairly well-contained. We ask people who are familiar with Dendrite to leave the [good first issue](https://github.com/matrix-org/dendrite/labels/good%20first%20issue) issues so that there is always a way for new people to come and get involved. -## Contributing to dependencies - -Dependencies are located in `vendor/src` and are managed by `gb`. If you need -to make some changes in those directories, you first need to open a PR in the -dependency repository. Once your PR is merged, you need to run `gb vendor -update $repo_url` (example: `gb vendor update github.com/matrix-org/gomatrix`) -in the dendrite repository to update the dependency. - -You can then create a commit containing only the modified vendor files (along -with the `vendor/manifest` file), name it with the command you just ran (ie -`gb vendor update github.com/matrix-org/gomatrix`), and open a PR on Dendrite. - ## Getting Help For questions related to developing on Dendrite we have a dedicated room on @@ -57,4 +47,3 @@ For more general questions please use [#dendrite:matrix.org](https://matrix.to/# We ask that everyone who contributes to the project signs off their contributions, in accordance with the [DCO](https://github.com/matrix-org/matrix-doc/blob/master/CONTRIBUTING.rst#sign-off). - |