Wikibase/Suite-Contributing-Guide

Contributor How-To

edit

Welcome and thank you so much for showing interest in contributing to Wikibase Suite! We are so happy to have you here. This contributing guide will give you a basic rundown of almost everything you need to know to contribute to the project.

If you are new or need help

edit

You don’t know what is Wikibase and what it is used for:

You want to install Wikibase Suite:

You want to have a go at creating a MediaWiki extension to add some functionality but don’t know where to start:

If there is anything that you are not sure of, please feel free to contact us so we can figure it out.

Please also make sure to go over our coding guidelines before making any code contributions.

Ways to contribute

edit

We welcome all kinds of contributions to the project. Here is a list of kinds of contributions and how we go about them:

Help improve the software

Documentation and Case studies

Get help and connect with the community

Contact Us

edit

You can contact us at wikibase-suite-support@wikimedia.de or on our telegram channel for any questions you have.

If you want to discuss a particular partnership get in touch with the Data Partnerships Team at: swe_partnerships@wikimedia.de.

Find out more about Data Partnerships at Wikimedia Deutschland here: https://meta.wikimedia.org/wiki/Wikimedia_Deutschland/Data_Partnerships_Team.

Code Improvements

edit

We are happy to receive your PRs!

If you have an idea of your own, go ahead! Please make sure to add your idea on Phabricator so the community knows if something is being worked on. 🙂 Dive into the Phabricator Help if needed.

Otherwise, in this contribution team board you can find relevant tasks that we don't have the capacity to prioritize currently. The columns are a guide to the complexity of the tasks.

Please contact us before going into the rabbit hole on your own.

Another way to add functionalities to your Wikibase Suite instance is by adding a tool or extension. If you are interested in implementing one:

  • If you want to put it on our radar:
    • Create a ticket on Phabricator
    • Log your PRs on that ticket
  • Otherwise, just do it and enjoy. It’s Open Source!

The following is valid for any code contribution:

  • Make sure that the code follows the development guidelines.
  • If there is a ticket on Phabricator referencing the change you made, add it to the name of the PR. Otherwise, if you have the time, create a ticket. If not, please clearly describe the purpose of your code in the PR.
  • To be merged, the code needs to be reviewed by one member of the in-house team and, in the case of a major change, approved by the Product Manager. Please request a review from Wikibase Suite (wmde/wikibase-suite) on the PR.
  • Please keep in mind the focus areas we’ve decided on for this year. Your code improvement cannot go in any way against them. To have a voice in the future of those focus areas, please see the product definition section of this document.
  • We will endeavour to reply to all new PRs within 2 working weeks. Please note that due to holidays in December and August response times may be up to four weeks.

Documentation

edit

If you would like to make any changes to the documentation we have on our GitHub repository, please follow the same procedure as that of a code contribution.

If you would like to make changes on a wiki, feel free to do so yourself, it is a wiki after all!

Report a Bug

edit

Use this form.

Feature Request

edit

Use this form.

Join regular community meetings

edit

We have monthly Wikibase community meetings on the last Thursday of every month. Feel free to hop on and meet fellow Wikibase users and ask your questions! Reminders for these meetings are posted on the telegram channel. This meeting is hosted by the Wikibase Community User Group.

You can also join an active community of stakeholders to share knowledge, team up on shared projects, and participate in defining the future of Wikibase Suite at the Wikibase Stakeholder Group.

There’s also a wikibase-focused group of Digital humanities researchers, the DARIAH-EU hosted, DHWiki. In the DHWiki Wikibase, you can find a curated collection of scientific research about wikibase, and join the group if you’re interested.

Host a Wikibase Suite Meetup

edit

Got a great idea for a meetup around a topic or community that you're passionate about? Get in touch with wikibase-suite-events@wikimedia.de to get help to make it a reality!

The meetup can be a hackathon, workshop, project showcase, or any community-building event. We would love to hear and support your ideas!

Spread the word!

edit

If you would like to share and spread the word about Wikibase or Open Linked Data, you can tag us on social media platforms or share our links in the content. We would love to be a part of your journey in growing open linked data!

You can find our official materials in the following places:

Following are our social media handles: