fa9ae32a1a
* Updates to build and contributing guide. * Update .github/BUILD.md Co-authored-by: Sven Geusens <sge@umbraco.dk> * Add npm ci. * Apply suggestions from code review Co-authored-by: Sebastiaan Janssen <sebastiaan@umbraco.com> * Update .github/BUILD.md Co-authored-by: Sebastiaan Janssen <sebastiaan@umbraco.com> --------- Co-authored-by: Sven Geusens <sge@umbraco.dk> Co-authored-by: Sebastiaan Janssen <sebastiaan@umbraco.com>
64 lines
2.7 KiB
Markdown
64 lines
2.7 KiB
Markdown
# Contributing to Umbraco CMS
|
|
|
|
👍🎉 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 [what to consider before you start](contributing-before-you-start.md) and more detailed guides at the end of this article.
|
|
|
|
The following steps are a quick-start guide:
|
|
|
|
1. **Fork**
|
|
|
|
Create a fork of [`Umbraco-CMS` on GitHub](https://github.com/umbraco/Umbraco-CMS)
|
|
|
|
|
|
|
|
2. **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`.
|
|
|
|
|
|
|
|
3. **Switch to the correct branch**
|
|
|
|
Switch to the `contrib` branch
|
|
|
|
4. **Build**
|
|
|
|
Build your fork of Umbraco locally [as described in the build documentation](BUILD.md), you can build with any IDE that supports dotnet or the command line.
|
|
|
|
5. **Branch**
|
|
|
|
Create a new branch now and name it after the issue you're fixing, we usually follow the format: `v{major}/{feature|bugfix|task}/{issue}-{description}`. For example: `v15/bugfix/18132-rte-tinymce-onchange-value-check`.
|
|
|
|
This means it's a temporary branch for the particular issue you're working on, in this case a bug fix for issue number `18132` that affects Umbraco 15.
|
|
|
|
Don't commit to `contrib`, create a new branch first.
|
|
|
|
6. **Change**
|
|
|
|
Make your changes, experiment, have fun, explore and learn, and don't be afraid. We welcome all contributions and will [happily give feedback](contributing-first-issue.md#questions).
|
|
|
|
7. **Commit and push**
|
|
|
|
Done? Yay! 🎉
|
|
|
|
Remember to commit to your new `temp` branch, and don't commit to `contrib`. Then you can push the changes up to your fork on GitHub.
|
|
|
|
8. **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 instuctions.
|
|
|
|
Want to read further? [Creating a pull request and what happens next](contributing-creating-a-pr.md).
|
|
|
|
## Further contribution guides
|
|
|
|
- [Before you start](contributing-before-you-start.md)
|
|
- [Finding your first issue: Up for grabs](contributing-before-you-start.md)
|
|
- [Contributing to the new backoffice](https://docs.umbraco.com/umbraco-backoffice/)
|
|
- [Unwanted changes](contributing-unwanted-changes.md)
|
|
- [Other ways to contribute](contributing-other-ways-to-contribute.md)
|
|
|