Skip to content

Latest commit

 

History

History
132 lines (98 loc) · 5.76 KB

CONTRIBUTING.md

File metadata and controls

132 lines (98 loc) · 5.76 KB
Raw

Table of Contents

  1. Request for contributions
  2. How to contribute code
  3. How to contribute issues
  4. How to contribute documentation
  5. How to conduct yourself when contributing
  6. How to setup an OBS development environment

Request for contributions

We are always looking for contributions to the Open Build Service. Read this guide on how to do that.

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

  • code: contribute your expertise in an area by helping us expand the Open Build Service
  • 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

How to contribute code

  • Prerequisites: familiarity with GitHub Pull Requests

  • Fork the repository and make a pull-request with your changes

    • Please make sure to mind what our test suite in travis tells you
    • Please always increase our code coverage by your pull request

  • A developer of the open-build-service team will review your pull-request

    • If the pull request gets a positive review the reviewer will merge it

We tag our commits depending on the area that is affected by the change. Those are

  • [webui] - Changes in webui related parts of app/model/ and lib/ as well as app/controllers/webui/ and it's views
  • [api] - Changes in api related parts of app/model/ and lib/ as well as app/controllers/*.rb and it's views
  • [backend] - Changes in the perl-written backend of OBS
  • [ci] - Changes that affect our test suite
  • [doc] - Any documentation related changes

How to contribute issues

We are using priority labels from P1 to P4 for our issues. So if you are a member of the open-build-service team you are supposed to

  • P1: Urgent - Fix this next even if you still have other issues assigned to you.
  • P2: High - Fix this after you have fixed all your other issues.
  • P3: Medium - Fix this when you have time.
  • P4: Low - Fix this when you don't see any issues with the other priorities.

How to contribute documentation

The Open Build Service documentation is hosted in a separated repository called obs-docu. Please send pull-requests against this repository.

How to conduct yourself when contributing

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!

How to setup an OBS development environment

We are using Vagrant 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.

  1. Install Vagrant and VirtualBox. Both tools support Linux, MacOS and Windows.

  2. Install vagrant-exec:

    vagrant plugin install vagrant-exec

  3. Clone this code repository:

    git clone --depth 1 git@github.com:openSUSE/open-build-service.git

  4. Inside your clone update the backend submodule

    git submodule init
git submodule update

  5. Execute Vagrant:

    vagrant up

  6. Start your development backend with:

    vagrant exec contrib/start_development_backend

  7. Start your development frontend with:

    vagrant exec rails s

  8. 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 vagrant instance is configured with a default user 'Admin' and password 'opensuse'.

  9. Building packages: The easiest way to start building is to create an interconnect to build.opensuse.org. All resources, including the base distributions can be used that way directly. To set this up, follow these steps:

    • Login as admin and go to configuration page.
    • Go to the 'Interconnect' tab and press 'Save changes'. That creates an interconnect to build.opensuse.org.
    • Switch back to the 'Configuration' tab and press 'Update' to send your changes to the backend.
    • Restart the backend.
    • Now you can choose from a wide range of repositories to build your packages and images for.

  10. Changed something in the frontend? Test your changes!

    vagrant exec rake test
vagrant exec rspec

  11. Changed something in the backend? Test your changes!

    vagrant exec make -C src/backend test

  12. Explore the development environment:

    vagrant ssh

Happy Hacking! - ❤️ Your Open Build Service Team