We are a welcoming Free Software community and are always looking for new contributors to the Open Build Service. Read this guide on how to do that and what types of contributions this community seeks.
- How to contribute code
- How to review code submissions
- How to contribute bug reports
- How to contribute documentation
- How to conduct yourself when contributing
- How to setup an OBS development environment
- How to figure out what you can contribute to
Prerequisites: familiarity with GitHub Pull Requests
Fork the repository and make a pull request with your changes. A developer of the open-build-service team will review your pull request. And if the pull request gets a positive review, the reviewer will merge it.
But first, please bear in mind the following guidelines to create the perfect pull request:
If you see a glaring flaw within the Open Build Service, resist the urge to jump into the code and make sweeping changes right away. We know it can be tempting, but especially for large, structural changes(bug fixes or features) it's a wiser choice to first discuss them on the developer mailing list. It may turn out that someone is already working on this or that someone already has tried to solve this and hit a roadblock, maybe there even is a good reason why that flaw exists. If nothing else, a discussion of the change will usually familiarize the reviewer with your proposed changes and streamline the review process when you finally create a pull request.
A good rule of thumb for when you should discuss on the mailing list is to estimate how much time would be wasted if the pull request was rejected. If it's a couple of hours then you can probably dive head first and eat the loss in the worst case. Otherwise, making a quick check with the other developers could save you lots of time down the line.
A commit should contain a single logical change, the scope should be as small as possible. And a pull request should only consist of the commits that you need for your change (bug fix or feature). If it's possible for you to split larger changes into smaller blocks please do so.
Limiting the scope of commits/pull requests makes reviewing much easier. Because it will usually mean each commit can be evaluated independently and a smaller amount of commits per pull request usually also means a smaller amount of code to be reviewed.
We are keen on proper commit messages because they will help us to maintain this piece of code in the future. So for the benefit of all the people who will look at this commit now and in the future, follow this style:
- The title of your commit should summarizes what has been done
- If the title is too small to explain what you have done then elaborate on it in the body
- The body of your commit should explain why you have changed this. This is the most important content of the message!
- Make sure you also explain potential side-effects of this change, if there are any.
Please also mind common sense rules for commit messages, we wrote some down in our wiki https://github.com/openSUSE/open-build-service/wiki/Commit-Style
In order to make it as easy as possible for other developers to review your pull request we ask you to:
- Explain what this PR is about in the description
- Explain the steps the reviewer has to follow to verify your change
- If the reviewer needs sample data to verify your change, please explain how to create that data
- If you include visual changes in this PR, please add screenshots or GIFs
- If you address performance in this PR, add benchmark data or explain how the reviewer can benchmark this
This is a good PR description example:
Hey Friends,
this introduces labels for the different build result states on the project monitor page. This makes it easier to get a visual overview of what is going on in your project.
To verify this feature
- Enable the interconnect to build.opensuse.org
- Create the project home:Admin
- Add 'openSUSE Tumbleweed' as a repository to the project
- Branch a couple of packages into the project:
for i in `osc -A http://0.0.0.0:3000 ls openSUSE.org:home:hennevogel`; do osc -A http://0.0.0.0:3000 copypac openSUSE.org:home:hennevogel $i home:Admin; done- Visit the monitor page and see the new labels for the different states.
Here is a screenshot of how it looks:
Before
After
If the PR requires any particular action or consideration before deployment, set out the reasons in the PR description. Some examples are:
- Requires a database migration that can cause downtime. Postpone deployment until maintenance window.
- Contains a data migration that can cause temporary inconsistency, so should be run at a specific point of time.
- Changes some configuration files (e.g. options.yml), so the changes have to be applied manually in the reference server.
- A new Feature Toggle should be enabled in the reference server.
- Proper documentation or announcement has to be published upfront since the introduced changes can confuse the users.
Please make sure to mind our continuous integration cycle that includes:
- linting with tools like RuboCop, JSHint, haml-lint and brakeman.
- static code analysis with CodeClimate
- automated test runs for the frontend and backend test suites with CircleCI
If one of the goes wrong for your pull request please address the issue.
The Open Build Service developer community is here for you. If you are stuck with some problem or decision, have no time to drive a pull-request over the finishing line or if you just want to ask a simple question just get in contact with us in the pull-request, over the developer mailing list or our IRC channel (irc://irc.libera.chat/openSUSE-buildservice).
Prerequisites: familiarity with GitHub pull request reviews.
We believe every code submission should be reviewed by another developer to determine its maintainability. That means you, the reviewer, should check that the submitted code is:
- functional
- tested
- secure
- effective
- understandable
We also consider code reviews to be one of the best ways to share knowledge about language features/syntax, design and software architecture. So please take this seriously.
Changes to the business logic/behavior of the Open Build Service should alway be accompanied by tests (frontend/ backend) that will be run by our continuous integration.
However there is often a significant difference between something functional and something usable. So we strongly encourage manual testing during the code review. For this you should either check out the changes locally (see the "view command line instructions" link at the bottom of every PR) and run them in your development environment.
Or you make use of our review app bot
(by applying the review-app label to the PR) which will deploy the code to
our review server and tell you how to access it in a comment.
The tone of your code review will greatly influence morale within our community.
Harsh language in code reviews creates a hostile environment, opinionated language turns people defensive. Often leading to heated discussions and hurt feelings. On the other hand a positive tone can contribute to a more inclusive environment. People start to feel safe, healthy and lively discussions evolve.
So here are some basic rules we aspire to follow (we took inspiration from GitLab for these) to foster constructive, positive feedback.
- Be respectful to each other: We are in this together!
- Be humble: Reviews aren't about showing off (Example: "I'm not sure - let's look it up.")
- Be explicit: People don't always understand your intentions online.
- Be careful about the use of sarcasm: Everything we do is public; what seems like good-natured kidding to you and a long-time friend, might come off as mean and unwelcoming to a person new to the project
- Accept that many decisions are opinions: Discuss trade-offs and preferences openly
- Propose solutions instead of only requesting changes. (Example: "What do you think about naming this
:user_idinstead of:db_user?") - Ask for clarification instead of assuming things (Example: "I don't understand this change. Can you clarify this for me please?")
- Consider one-on-one chats or video calls if there are too many things that are not clear. Afterward post a follow-up comment summarizing the discussion you had, so everybody can follow your decision.
- Avoid expressing selective ownership of code ("my code", "not my code", "your code"), we are a community and share ownership
- Avoid using terms that could be seen as referring to personal traits. (Example: "dumb", "stupid", "simple"). Assume everyone is attractive, intelligent, and well-meaning, because everyone is!
- Don't use hyperbole. (Example: "always", "never", "endlessly", "nothing").
- Avoid asking for changes which are out of scope. Things out of scope should be addressed at another time (open an issue or send a PR).
In order to merge a pull request, it needs:
- The required GitHub checks to pass (waiting for all checks to pass is recommended)
- A review from at least one OBS developer
- All requested changes to be addressed*
* Dismissing a review with requested changes should only be done if we know the reviewer is not reachable for a while.
- Prerequisites: familiarity with GitHub Issues.
- Enter your issue and a member of the open-build-service team will label and prioritize it for you.
The Open Build Service documentation is hosted in a separated repository called obs-docu. Please send pull-requests against this repository.
The Open Build Service is part of the openSUSE project. We follow all the openSUSE Guiding Principles! If you think someone doesn't do that, please let any of the openSUSE owners know!
We are using docker to create our development environment. All the tools needed for this are available for Linux, MacOS and Windows.
Please note that the OBS backend uses advanced filesystem features that require an case sensitive filesystem (default in Linux, configurable in MacOS/Windows), make sure you run all this from a filesystem that supports this. Here you have some instructions in case you are a MacOS user.
-
Install docker (version >= v2)¹ There is documentation about this for openSUSE and various other operating systems.
¹ A version greater than v2 is required for docker compose subcommand to work.
-
Install rake
-
Clone this code repository:
git clone --depth 1 [email protected]:openSUSE/open-build-service.git -
Inside your clone update the backend submodule
git submodule init git submodule update -
Build your development environment with:
rake docker:build -
Start your development environment with:
docker compose up -
Check out your OBS frontend: You can access the frontend at localhost:3000. Whatever you change in your cloned repository will have effect in the development environment. Note: The development environment is configured with a default user 'Admin' and password 'opensuse'.
-
Building packages: The easiest way to start building is to create an interconnect to our reference server. All resources from the openSUSE instance, including the base distributions, can be used that way. To set this up, follow these steps:
- Login as Admin and go to 'Configuration' page.
- Go to the 'Interconnect' tab and press 'Connect' on 'Standard OBS instance'. That creates an interconnect to build.opensuse.org.
- Now in any other project you can choose from a wide range of distributions to build your packages on the 'Repositories' tab.
-
Changed something in the frontend? Test your changes!
docker compose run --rm frontend bundle exec rspec docker compose run --rm frontend bundle exec rake dev:lint:all -
Changed something in the backend? Test your changes!
docker compose run --rm backend make -C src/backend test -
You can find more details about the development environment in our wiki.
This we track in our What to Contribute guide. Check it out!