Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 3.82 KB

CONTRIBUTING.md

File metadata and controls

68 lines (46 loc) · 3.82 KB

Contributing to Open Integration Hub

Contributions to the Open Integration Hub include code and documentation for all types of Open Integration Hub contributors.

If you plan to make your first contribution, please start with the Contributor Guide for general information about making contributions to the Open Integration Hub project.

The following represent additional rules specifically for contributions in this workgroup and repository.

Code of Conduct

The Open Integration Hub project has a code of conduct that follows the Contributor Covenant Code of Conduct. All contributors are expected to follow this code of conduct.

Issues

Issues in openintegrationhub/openintegrationhub are categorized in two types:

  1. Bug Reports: To report a bug, please click on New Issue, select the bug report template and complete it
  2. Open Tasks: To report an open task or feature request, please click on New Issue, select the Custom Issue Template and complete it
  3. Discussions/Open Questions: To start a new discussion or to flag an open question that needs answering, please click on New Issue, select the Discussion/Open Question Template and complete it

Definition Of Done

The definition of done for each issue:

  • All acceptance criteria have been fulfilled
  • Output published on GitHub under github.com/openintegrationhub

DoD Documents

In addition to the previously defined definition of done some rules only apply for outputs of type document:

  • Workgroup consensus about output (has to be accepted) i.e. each teamlead approved the pull request
  • All concepts must include information about the creator, last modifier and last modification date
  • (Microservice)concept:
    • Have to be published under github.com/openintegrationhub/microservices
    • Services are described in a common form using the microservice template
    • All predefined section of the template are filled
  • Architecture Concepts:
    • Have to be published under github.com/openintegrationhub/architecture
  • Architecture Decisions:
    • Have to be published under github.com/openintegrationhub/architecture
    • Decisions are described in a common form using the architecture decision template
  • Concept / document reviewed and accepted by CES quality manager

DoD Services

In addition to the previously defined definition of done some rules only apply for outputs of type code:

  • Code is compliant with styleguide
  • Code is compliant with devops/operations guidelines
  • Dependent documentation have been updated (See DoD for documents)
  • All new features are tested in development mode (unit tests)
  • Once we have integration tests:
    • Integration tests were successful applied
    • Dependencies between software modules are documented

Pull Requests

Pull Requests are the way concrete changes are made to the repository.

  • Assign all development leads or the appropiate team lead to the pull request (@drobiazko, @sachmerz, @hschmidthh, @RobinBrinkmann)
  • If you don't know whom to assign, choose: @RobinBrinkmann
  • Select an appropriate label (choose the dependent service and/or framework(e.g. Smart Data Framework) or if no current label fits choose general)