Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 5.45 KB

CONTRIBUTING.md

File metadata and controls

103 lines (75 loc) · 5.45 KB
Raw

Contributing

We appreciate all kinds of contributions. The following is a set of guidelines for contributing to this repository on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Prerequisites

Asking Questions

What should I know before I get started?

How Can I Contribute?

Prerequisites

This project and everyone participating in it are governed by our Code of Conduct. By participating, you are expected to uphold this code.

Asking questions

Do not know how something in this project works? Curious if this project can achieve your desired functionality? Please ask questions in this project discussions here

What should I know before I get started?

Tools and Packages

This project can be built, tested and packaged using Maven.

mvn clean package

How Can I Contribute?

Reporting Bugs

To report a bug, submit an issue with the label bug. Please ensure the bug has not already been reported. If the bug is a potential security vulnerability, please report it using our security policy.

Providing the following information will increase the chances of your issue being dealt with quickly:

  • Overview of the Issue - if an error is being thrown a non-minified stack trace helps
  • Toolchain and Environment Details - which versions of libraries, toolchain, platform etc
  • Motivation for or Use Case - explain what are you trying to do and why the current behavior is a bug for you
  • Browsers and Operating System - is this a problem with all browsers?
  • Reproduce the Error - provide a live example or a unambiguous set of steps
  • Screenshots - maybe screenshots can help the team to triage issues far more quickly than a text description
  • Related Issues - has a similar issue been reported before?
  • Suggest a Fix - if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)

You can help the team even more by submitting changes with a fix.

Suggesting Enhancements

To suggest a feature or enhancement, please submit an issue with the label enhancement. Please ensure the feature or enhancement has not already been suggested.

Please consider what kind of change it is:

  • For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
  • Small Features can be crafted and directly submitted changes.

Submitting Changes

Before you submit your Pull Request (PR) consider the following guidelines:

  • Make your changes in a new git branch:

    git checkout -b my-fix-branch main

  • Create your patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Test your changes with our supported browsers and screen readers.

  • Run tests and ensure that all tests pass.

  • Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.

    git commit -a -S

    Note: The optional commit -a command line option will automatically "add" and "rm" edited files.

    Note: The command line option -S generates a signed commit, which is required to make a contribution (See Developer Certificate of Origin)

  • Push your branch to GitHub:

    git push my-fork my-fix-branch

  • In GitHub, send a pull request to sbb-your-project:main. The PR title and message should as well conform to the commit message conventions.

Commit Message Guidelines

This project uses Conventional Commits to generate the Changelog using the Release Please GitHub action. For comprehensive information, please consult the Release Please documentation.

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All API methods must be documented.
  • Also see CODING_STANDARDS.md