Skip to content

Latest commit

 

History

History
43 lines (26 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

43 lines (26 loc) · 3.09 KB

🌱 Contributor Guidelines

By contributing you agree to the terms of the Candle Cookbook License and Code of Conduct.

We welcome contributions from anyone who aligns with Our Mission and Our Principles -- all you need is a GitHub Account.

Contributor Checklist:

  • Read and adhere to our Code of Conduct
  • Install Candle Cookbook according to the Developer Setup guide
  • For recipes: follow the formatting conventions in the recipe template
  • Ensure make cookbook passes before submitting any changes
  • Review Cookbook changes and test hyperlinks by running make serve
  • For pull requests: follow the PR Requirements

⚠️ IMPORTANT: Once you have submitted a PR do not push any further changes. If you wish to make edits, delete the PR and submit a new one.

❌ NEVER FORCE PUSH: i.e. git push origin my-branch --force


Here are 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 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. Otherwise you can open a ticket.

  • Help build our community -- pick an open ticket 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 a recipe step-by-step and offer technical improvements or extensions. Submit your improvements as a pull request according to the PR Requirements.

  • Resolve a bug -- pick an open ticket then test, validate and submit a solution by completeing a pull request according to the PR Requirements.

Head Chef

  • Create a recipe -- create your own recipe using the recipe template then test, validate and submit your recipe by completeing a pull request according to the PR Requirements.

  • Review a PR -- pick an open PR. First ensure the PR has passed the deploy CI/CD status check. Next 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 status 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"