From 06284d05f123f31563e015bc97879159539fcaf5 Mon Sep 17 00:00:00 2001 From: Adam <20446095+aadam-10@users.noreply.github.com> Date: Mon, 23 Dec 2024 21:18:05 +0100 Subject: [PATCH] Update CONTRIBUTING.md (#3114) --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fb8f22d03..e2b691059 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,9 @@ ## Contributing -Bug fixes and enhancements are welcome! - -*Please don't open pull requests to add tokens to Connect.* Instead, use the `tokensConfig` parameter in `config` to add tokens into your deployment of Connect. +- Instead of opening opening pull requests to add tokens directly into Wormhole Connect, please use the configuration to add them into your own deployment. +- We welcome typo and grammar fixes to *public facing* documents. This includes things like the whitepapers, but excludes inline code comments. PRs that touch only the latter will be rejected. Fixing typos in comments alongside other non-trivial engineering work is welcome. +- Pull requests that modify dependencies must be well-documented so that the benefits of updating can be weighed against security and compatibility concerns. Low-effort PRs that update dependencies without any documentation will be rejected. +- Feature additions must be discussed ahead of time before a pull request is created. ### Setup