Skip to content

What to contribute

Lukas Krause edited this page May 9, 2023 · 30 revisions

We are always looking for contributions to the Open Build Service.

In particular, this community seeks the following types of contributions:

  • code: bug-fix and expand the features of the Open Build Service
  • UI/UX design: Improve the look of the OBS UI and enhance how the UI elements work together to create a seamless user experience
  • ideas: participate in an issues thread or start your own to have your voice heard
  • copy editing: fix typos, clarify language, and generally improve the quality of the content of the Open Build Service

Read this guide to understand what you can contribute to do that.

What code to contribute?

Once you are clear on how to contribute code here's a list of things the Open Build Service especially will benefit from.

Good first Ruby on Rails contributions (beginner difficulty)

We maintain a list of bugs and features that we think are easy to start with for the Ruby on Rails application that serves the user and the API interface of the OBS.

If you are new to OBS and/or new to Ruby on Rails this is a good starting point to become a regular contributor to this part of the OBS.

Ruby on Rails / Ruby Upgrades (intermediate difficulty)

Ruby on Rails is an actively maintained framework we are trying to stay up to date with. So multiple times a year there are major/minor upgrades with new features and potentially the need for some manual steps/fixes. Luckily we have a documented way to doing this with next_rails and our ruby packages to follow.

Address Ruby on Rails Technical Debt / Anti-Patterns (expert difficulty)

We maintain a list of technical debt we took on and have have the obligation repay some time...

https://trello.com/b/yLs6IuoT

If you are a Ruby on Rails expert this is a good starting point to find things worth working on. Many of them include introducing new software design patterns to the code base, major architectural changes and fixing complicated issues. Very good opportunities to get exposure for your Rails kung-fu!

Which UI/UX design to contribute?

Web Content Accessibility

We would ❤️ to comply to the Web Content Accessibility Guidelines (WCAG) international standard on each and every page in our UI. But we have many issues and no automated accessibility testing.

Which writing to contribute?

OBS Books

  • Proofread
  • Update screenshots
  • Add chapters

Blog Posts for openbuildservice.org

  • Introduction to workflows / features
  • How to do XYZ... articles

Developer Wiki

  • Document sub-systems
  • How to do XYZ... pages

Which testing to contribute?

Beta program

When we are introducing new features or bigger redesigns of existing patterns in the Open Build Service, we do this as part of the beta program. In order to push those features in the right direction, we rely on the feedback of users. You can contribute by joining the beta program and help with us with your feedback. This can include:

  • reporting bugs
  • feedback on design decisions
  • feedback on your experience using the feature
  • missing functionality
  • and more...

How To Give Us Feedback

There are two ways to reach us:

Please note that we favor GitHub to gather feedback as it allows us to easily keep track of the discussions.

Clone this wiki locally