From b4d8288b5361500ee313ad3bf00ddb1441177892 Mon Sep 17 00:00:00 2001 From: Kahlia Hogg <47726907+athletedecoded@users.noreply.github.com> Date: Wed, 18 Oct 2023 16:03:47 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5f5361c..60ea013 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,25 +2,26 @@ By contributing you agree to the terms of the Candle Cookbook [License](./LICENSE) and [Code of Conduct](./CODE_OF_CONDUCT.md). -We welcome contributions from anyone who aligns with Our Mission and Our Principles! The only requirement is that you have a [GitHub Account](https://github.com/join). - -Below you'll find some contribution ideas depending on your level of experience and familiarity with git, Rust and Candle. +We welcome contributions from anyone who aligns with Our Mission and Our Principles! All you need is a [GitHub Account](https://github.com/join). Before starting please complete the Contributor Checklist: -- [ ] Understand and adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md) -- [ ] If you're creating a recipe use the [recipe template](./recipe.md) -- [ ] If you're submitting a pull request review the [PR Requirements](PR_REQS.md) +- [ ] Review and adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md) +- [ ] If you're creating a recipe, start from the [recipe template](./recipe.md) +- [ ] If you're submitting a pull request, follow the [PR Requirements](PR_REQS.md) + + +Here some contribution ideas depending on your level of experience and familiarity with git, Rust and Candle. ### Junior Chef -* **Test out a recipe** -- complete the recipe step-by-step and suggest how to make the recipe more clear. If you're comfortable with git, complete a pull request according to the [PR Requirements](PR_REQS.md). Otherwise you can open [a ticket](https://github.com/nogibjj/candle-cookbook/issues). +* **Test out a recipe** -- complete the recipe step-by-step and suggest improvements to the language or instructions to make the recipe more clear. If you're comfortable with git, complete a pull request according to the [PR Requirements](PR_REQS.md). Otherwise you can open [a ticket](https://github.com/nogibjj/candle-cookbook/issues). -* **Help build our community** -- pick an [open ticket](https://github.com/nogibjj/candle-cookbook/issues?q=is:issue%20is:open) and engage in the resolution process. Contribute to the discussion by offering guidance, solutions or by asking clarifying questions. +* **Help build our community** -- pick an [open ticket](https://github.com/nogibjj/candle-cookbook/issues?q=is:issue%20is:open) and engage in the problem resolution process. Contribute to the discussion by offering guidance, solutions or by asking clarifying questions. ### Sous Chef -* **Improve a recipe** -- complete the recipe step-by-step and offer technical improvements or extensions. If you're comfortable with git, complete a pull request according to the [PR Requirements](PR_REQS.md). Otherwise you can open [a ticket](https://github.com/nogibjj/candle-cookbook/issues). +* **Improve a recipe** -- complete a recipe step-by-step and offer technical improvements or extensions. Submit your improvements as a pull request according to the [PR Requirements](PR_REQS.md). * **Resolve a bug** -- pick an [open ticket](https://github.com/nogibjj/candle-cookbook/issues?q=is:issue%20is:open) then test, validate and submit a solution by completeing a pull request according to the [PR Requirements](PR_REQS.md). @@ -28,8 +29,7 @@ Before starting please complete the Contributor Checklist: * **Create a recipe** -- create your own recipe using the [recipe template](./recipe.md) then test, validate and submit your recipe by completeing a pull request according to the [PR Requirements](PR_REQS.md). -* **Review a PR** -- pick [an open PR](https://github.com/nogibjj/candle-cookbook/pulls?=qis:pr%20is:open). Check the PR check has passed then test and validate any code additions. Submit your review outcome in the comments section according to the traffic-light system. `@` tag one of the community leaders in your comment. +* **Review a PR** -- pick [an open PR](https://github.com/nogibjj/candle-cookbook/pulls?=qis:pr%20is:open). First ensure the PR check has passed, then test and validate any code additions. Submit your review outcome in the comments section according to the traffic-light system. `@` tag one of the community leaders in your comment to finalise the merge. * 🔴 If the PR check has failed or there are major flaws write "NOT APPROVED" including your reasons * 🟡 If the PR needs minor changes (i.e. formatting/clarity) write "CHANGES REQUIRED" including your suggestions * 🟢 If the PR is merge ready write "VALIDATED & APPROVED" - . \ No newline at end of file