Refer to CONTRIBUTING from README #572
Conversation
Signed-off-by: Andy Balaam <[email protected]>
There was a problem hiding this comment.
My only issue with this is that the instructions for manually testing in CONTRIBUTING appear to be out of date, the port number should be 9999 (as referenced in the section to be deleted) - that should be changed before this is merged - but otherwise this seems fine.
|
@H-Shay mx-tester uses a reverse proxy to test the report forwarding functionality https://github.com/matrix-org/mjolnir/blob/main/mx-tester.yml#L11, it's not out of date it's just making sure that your client connects via the proxy. |
|
Happy to make updates if you decide they are needed - not yet sure what to do based on the comments above. |
|
Ah sounds like the README section was out of date then, all the more reason to nuke it. Thanks for the insight @Gnuxie and the PR @andybalaam. |
Some development info was written up in README.md, but most of the useful info is in CONTRIBUTING.md, so this PR deletes the section from README and instead refers to CONTRIBUTING. I hope that makes sense, but if not, no worries!
From reading what is in README, I think it's all covered in CONTRIBUTING, but please do check before merging this, in case something important is being deleted.