From 300d4273e0c339a6301b2d8bed70cfe241b0d8c2 Mon Sep 17 00:00:00 2001 From: Naama Bendalak <74866605+8naama@users.noreply.github.com> Date: Tue, 13 Aug 2024 13:32:00 +0300 Subject: [PATCH] fixes following review --- CONTRIBUTING.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 03e8ef9..ce000c2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,19 +45,19 @@ Or if you prefer, you can [open an issue on GitHub](https://github.com/logzio/lo ### Code Contributions -1. Checkout a new branch -2. Make your changes -3. Build the docker image locally to test your changes -4. Push your changes and open a new PR +1. Checkout a new branch following the naming convention: `bugfix/` or `feature/`. +2. Make your changes. +3. Build the docker image locally to test your changes. +4. Push your changes and open a new PR. ### Improving The Documentation You can either: 1. Reach out to Logz.io Support team using the chat icon located in the bottom-right corner of your Logz.io account. 2. [Open an issue on GitHub](https://github.com/logzio/logzio-api-fetcher/issues/new), and our team will address it as soon as possible. -3. Open a PR with the needed changes - - Checkout a new branch - - Make your changes - - Push your changes and open a new PR +3. Open a PR with the needed changes. + - Checkout a new branch following the naming convention: `doc/`. + - Make your changes. + - Push your changes and open a new PR. ## Attribution This guide is based on the **contributing-gen** ❤️ [Make your own](https://github.com/bttger/contributing-gen)!