Skip to content

Files

Latest commit

 

History

History

src

README.md

🛠️ FinOps toolkit source

Welcome aboard! 👋 If this is your first time to our repo, here are a few tips:

  • Every folder has a README that explains its purpose.
  • If you want to know how to deploy a FinOps toolkit solution, start with the documentation.
  • If you want to know how you can contribute, check out the contribution guide.
  • If you want to contribute and need to get started with the code, start in the wiki.
  • If you're looking for code, you're in the right place.   ← YOU ARE HERE
    ...but check the wiki to get on the right branch, understand the folder structure, and learn how to build and deploy.

On this page:

⚡ Quickstart guide

  1. ⬇️ Install Azure PowerShell and the Bicep CLI. Visual Studio Code is recommended.
  2. ▶️ Start in the dev branch (or applicable feature branch).
  3. 👩‍💻 Make your change and build/deploy using local dev scripts:
 Set-Location "<root>/src/scripts"  # run from the scripts folder
 ./Deploy-Toolkit "<template-or-module-name>" -Build
  1. 📝 Update docs and the changelog.
  2. ✅ Submit a PR and address feedback daily.
  3. 🎉 Celebrate! You're done!

For more details, refer to the dev docs in the wiki.


🙏 Thank you!

Thanks for contributing to the FinOps toolkit!

Let us know if there's anything we can do to streamline the contribution process. Like a good FinOps team, we're always looking for ways to optimize 😉