Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 2.37 KB

Contributing Guidelines

To contribute to the community site, you can fork & clone our repository, make your edits, and simply push back to GitHub and send us a pull request. All items that get pulled into the main repository will automatically get pushed to our.umbraco.org.

Getting started with Git and GitHub

Repository organisation

All active work done on the documentation is currently being done on the main branch.

Contributing

First fork and clone the repository so that you have your own working copy. Then create a new branch on your local copy to make your changes. Once you are happy with your edits, use GitHub to issue a "pull request", which means your edits will be reviewed, and once accepted, merged into the main repository.

Syncing your fork with the original repository

It's a good idea to pull in upstream changes, merge and commit to your own fork before submitting a pull request. To do this and sync your fork with this original one, you'll have to add the upstream url once:

git remote add upstream git://github.com/umbraco/OurUmbraco.git

And then each time you want to get the changes:

git fetch upstream
git rebase upstream/main

There's more information on how this works here

Community Area

As described in README.md parts of Our such as the karma leaderboard, current and previous MVPs, badges and Meetups has been moved to a new website. If you wish to help change, for example, the karma leaderboard, feel free to make a change to the data structure on Our and Umbraco will reflect the frontend changes on the new website.

These are the endpoints used:

  • /umbraco/api/badge/getbadgegroups (BadgeController.cs)
  • /umbraco/api/mvp/getall (MvpController.cs)
  • /umbraco/api/karma/getkarmastatistics (KarmaController.cs)
  • /umbraco/api/blog/getall (BlogController)
  • /umbraco/api/video/getall (VideoController.cs)
  • /umbraco/api/meetup/index (MeetupController.cs)

Planning & discussions

Use Github issues for reporting and discussing issues.