From 8fee4a6503145de696b6c0b1c3db909baeafd189 Mon Sep 17 00:00:00 2001 From: Christophe Le Bars Date: Mon, 10 Apr 2023 17:13:38 +0200 Subject: [PATCH] improve CONTRIBUTING.md --- CONTRIBUTING.md | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 08a9c20..b68a4d0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,27 +1,28 @@ # Contributing to ethers-svelte -Thanks for your interest in improving ethers-svelte! We welcome -contributions of all kinds: from discussion to documentation to -bugfixes to feature improvements. +Thank you for your interest in improving ethers-svelte! We welcome contributions of all kinds: from discussions and documentation to bug fixes and feature enhancements. -Please review this document to help to streamline the process and save -everyone's precious time. +Please review this document to help streamline the process and save everyone's precious time. ## Issues -No software is bug-free. So, if you got an issue, follow these steps: +No software is bug-free. If you encounter an issue, follow these steps: -- Search the [issue list](https://github.com/clbrge/ethers-svelte/issues) for current and old issues. - - If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues! -- If none of that is helping, create an issue with the following information: - - Clear title (shorter is better). - - Describe the issue in clear language. - - Share error logs, screenshots and etc. - - To speed up the issue fixing process, send us a sample repo with the issue you faced. +1. Search the [issue list](https://github.com/clbrge/ethers-svelte/issues) for current and old issues. + - If you find an existing issue, please UPVOTE the issue by adding a "thumbs-up reaction". We use this to help prioritize issues! +2. If none of that is helping, create an issue with the following information: + - Clear title (shorter is better). + - Describe the issue in clear language. + - Share error logs, screenshots, etc. + - To speed up the issue fixing process, send us a sample repo with the issue you faced. ## Pull Requests (PRs) -We welcome all contributions. +We welcome all contributions. Before submitting a pull request, please ensure you have followed these guidelines: -You are encouraged to join the community on -[Discord](https://discord.gg/7yXuwDwaHF) to discuss your PR: +1. Make sure your code follows the [Standard JavaScript style](https://standardjs.com/). +2. Provide a clear and concise description of the changes in the PR title and description. +3. Ensure that your changes do not introduce new linting or test errors. +4. Update any relevant documentation or tests as necessary. + +You are encouraged to join the community on [Discord](https://discord.gg/7yXuwDwaHF) to discuss your PR: