Contributing
DocumentationGitHub
  • Contributing to Umbraco
  • Hacktoberfest 2024
    • Contributing to Hacktoberfest
  • Documentation
    • How to contribute
      • Submit a Pull Request
      • Submit Feedback
      • Create a new version of an article
    • Style Guide
      • Markdown Conventions
      • Code Blocks
      • Structure
    • UmbracoDocs on GitHub
  • Umbraco-CMS
    • How to contribute
      • Before you start
      • Finding your first issue: Up for grabs
      • Building the codebase
      • Unwanted changes
      • Other ways to contribute
    • Umbraco-CMS on GitHub
  • UI Library
    • How to contribute
    • Components
    • Umbraco.UI on GitHub
  • Backoffice Project
    • How to contribute
    • Umbraco.CMS.Backoffice on GitHub
Powered by GitBook
On this page
  • Getting Started
  • Further contribution guides

Was this helpful?

Export as PDF
  1. Umbraco-CMS

How to contribute

PreviousStructureNextBefore you start

Last updated 3 days ago

Was this helpful?

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

These contribution guidelines are mostly just that - guidelines, not rules. This is what we've found to work best over the years, but if you choose to ignore them, we still love you! 💖 Use your best judgement, and feel free to propose changes to this document in a pull request.

Getting Started

We have a guide on and more detailed guides at the end of this article.

The following steps are a quick-start guide:

  1. Fork

    Create a fork of

  1. Clone When GitHub has created your fork, you can clone it in your favorite Git tool or on the command line with git clone https://github.com/[YourUsername]/Umbraco-CMS.

  1. Switch to the correct branch Switch to the main branch

  2. Build

    Build your fork of Umbraco locally as shown in the video below. You can build with any IDE that supports dotnet or the command line.

  1. Branch Create a new branch now and name it after the issue you're fixing, we usually follow the format: temp/12345. This means it's a temporary branch for the particular issue you're working on, in this case issue number 12345. Don't commit to main, create a new branch first.

  2. Change

  3. Commit and push

    Done? Yay! 🎉

    Remember to commit to your new temp branch, and don't commit to main. Then you can push the changes up to your fork on GitHub.

  4. Create pull request

    On GitHub, in your forked repository (https://github.com/[YourUsername]/Umbraco-CMS) you will see a banner saying that you pushed a new branch and a button to make a pull request. Tap the button and follow the instructions.

If you encounter errors while building the project, make sure you're using the latest supported versions of Node.js and npm.

Further contribution guides

Make your changes, experiment, have fun, explore and learn, and don't be afraid. We welcome all contributions and will .

Want to read further? .

Creating a pull request and what happens next
Before you start
Finding your first issue: Up for grabs
Unwanted changes
Other ways to contribute
what to consider before you start
Umbraco-CMS on GitHub
happily give feedback
Fork the repository
Clone the fork