From 363963460c35779a6604086219ae52c8c14f719a Mon Sep 17 00:00:00 2001 From: aniket-engg Date: Fri, 3 Nov 2023 13:21:18 +0530 Subject: [PATCH] updated contribution file --- CONTRIBUTING.md | 8 ++++---- team-best-practices.md | 7 ++----- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index be04f3359d..a603101311 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ # Contributing -Everyone is very welcome to contribute on the codebase of Remix. Please reach us in [Gitter](https://gitter.im/ethereum/remix) in case of any queries. +Everyone is very welcome to contribute on the codebase of Remix. Please join our [Discord](https://discord.gg/mh9hFCKkEq) in case of any queries. ## Development Remix libraries work closely with [Remix IDE](https://remix.ethereum.org). Each library has a readme to explain its application. -When you add a code in any library, please ensure you add related tests. You can visit [here](https://github.com/ethereum/remix-ide#installation) to test your changes by linking the remix libraries with Remix IDE. +When you add a code in any library, please ensure you add related unit tests. ## Coding style @@ -101,7 +101,7 @@ Well, that depends. If you update an old json file, then you don't need to update it in other languages, because crowdin will do it for you. -But if you add a new json file, then you have to add it in other languages, and import it in `index.js` of all languages. Because crowdin will not update `index.js`, you have to do it manually. +But if you add a new json file, only English is needed. ### How to contribute on translations? Remix is using crowdin to manage translations. If you want to contribute on that, you can do it on crowdin. Check the link below. @@ -110,4 +110,4 @@ https://crowdin.com/project/remix-translation There are many languages, just get into your language, and you will see a folder named `Remix UI`, where you can do the translations. -Not only can you do the translations, you can also review it. If you agree or disagree with some translations, you can vote yes or no. If you vote no, you can comment to explain why you vote no, and give your translation. +Not only you can do the translations, you can also review it. If you agree or disagree with some translations, you can vote YES or NO. If you vote NO, you can comment to explain why you vote NO, and give your translation. diff --git a/team-best-practices.md b/team-best-practices.md index a05714dc5d..d9b4b8baec 100644 --- a/team-best-practices.md +++ b/team-best-practices.md @@ -20,10 +20,7 @@ Related links: - Remix-debug NPM module: https://www.npmjs.com/package/@remix-project/remix-debug - Remix-tests NPM module: https://www.npmjs.com/package/@remix-project/remix-tests - Remix documentation: http://remix-ide.readthedocs.io/en/latest/ - - General gitter channel: https://gitter.im/ethereum/remix - - Dev gitter channel: https://gitter.im/ethereum/remix-dev - - Dev plugin gitter channel: https://gitter.im/ethereum/remix-dev-plugin - + - Discord: https://discord.gg/mh9hFCKkEq --- @@ -187,4 +184,4 @@ Before starting coding, we should ensure all devs / contributors are aware of: # Coding best practices - - https://github.com/ethereum/remix-project/blob/master/best-practices.md + - https://github.com/ethereum/remix-project/blob/master/CONTRIBUTING.md