From f8dbed526b1e6cd31f8b1a6cf3a9a0255abfb5f8 Mon Sep 17 00:00:00 2001 From: abdellah boutmad Date: Mon, 7 Oct 2024 12:37:14 +0100 Subject: [PATCH] correct a few errors in contributing.md file --- CONTRIBUTING.md | 37 ++++++++++++++++++------------------- 1 file changed, 18 insertions(+), 19 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 406fb61..5d86b72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,36 +1,35 @@ + # Contributing to Starkiller -We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's: +We appreciate your input! Our goal is to make contributing to this project as easy and transparent as possible, whether you're: - Reporting a bug - Discussing the current state of the code - Submitting a fix - Proposing new features +- Creating GitHub Issues -## Creating Github Issues - -Please first review the existing Starkiller issues to see if the error was resolved with a fix in the development branch or if we chose not to fix the error for some reason. +Before submitting, please review the existing Starkiller issues to check if the error has been resolved in the development branch or if we decided not to fix it for any reason. -The more information you provide in a Github issue the easier it will be for us to track down and fix the problem: +The more information you provide in a GitHub issue, the easier it will be for us to track down and resolve the problem: -- Please provide the version of Empire you are using. -- Please provide the OS, and Starkiller version that you are using. -- Please describe the expected behavior and the encountered error. - - The more detail the better! - - Include any actions taken just prior to the error. - - Please post a screenshot of the error, a link to a Pastebin dump of the error, or embedded text of the error. - - Any additional information. +- Specify the version of Empire you're using. +- Provide the OS and Starkiller version you're using. +- Describe the expected behavior and the error you encountered. +- The more detail, the better! +- Include any actions you took just before the error occurred. +- Post a screenshot of the error, a link to a Pastebin dump, or embed the error text. +- Any additional relevant information. ## Making a Pull Request -1. Create an issue describing the motivation for your changes - - - Pull Requests without associated Issues may still be accepted, if the motivation is obvious. However, this will help speed up code review if there's any uncertainty. +Start by creating an issue to describe the motivation behind your changes. -1. Fork the repo and create your branch from main. -1. Make sure your code lints. -1. Issue that pull request! +Pull requests without associated issues may still be accepted if the motivation is obvious. However, linking to an issue can help speed up code review if there’s any uncertainty. +- Fork the repo and create your branch from the `main` branch. +- Ensure your code lints correctly. +- Submit that pull request! ## Use a Consistent Coding Style -We use Airbnb's and Vue's recommended ESLint configs. To make your life easier, consider installing an ESLint plugin in your editor of choice. You can also run `yarn lint`. +We follow Airbnb's and Vue's recommended ESLint configurations. To make your life easier, consider installing an ESLint plugin in your preferred editor. You can also run `yarn lint`.