Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (41 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

67 lines (41 loc) · 3.01 KB

Contributing Guidelines

Initial Setup

The initial setup is trivial:

  • clone this repo
  • npm i

Full Build

To run the full Continuous Integration build run npm run ci in either the top-level package or a specific subpackage.

Release Life-Cycle.

This monorepo uses Lerna's Fixed/Locked which means all the sub-packages share the same version number.

Release Process

Release is triggered via a Github Workflow:

  • Open bump versions and tag Action GUI.
  • Click on the Run workflow button.
  • Choose automatic in `semver release type" drop down
    • You can also specify an exact semver bump (patch/minor/major).
  • Click on the Run workflow button.
  • Wait for the workflow to complete.
  • Track the newly pushed tag (/^v[0-9]+(\.[0-9]+)*/) release build in Github Actions
  • Inspect the newly artifacts published on npmjs.com / Github Releases.

Report an Issue

To report an issue please use the github issue tracker. Please try to make sure you have these in your issue:

  • No duplicate
  • Reproducible
  • Good summary
  • Well-documented
  • Minimal example

Issue handling process

When an issue is reported, a committer will look at it and either confirm it as a real issue (by giving the "in progress" label), close it if it is not an issue, or ask for more details. In-progress issues are then either assigned to a committer in GitHub, reported in our internal issue handling system, or left open as "contribution welcome" for easy or not urgent fixes.

An issue that is about a real bug is closed as soon as the fix is committed.

Contribute Code

You are welcome to contribute code. PRs will be examined and if it fits the quality requirements and the roadmap of the product they will be merged.

If you contibute a new plugin, please make sure to include it also in sample-app/sample-app-vite. This is a sample application that includes all plugin and should be maintained for test purposes.

Please be aware to the ongoing Vue3 migration process. More details in the README.md file..

Commit Messages

This project uses conventional commits standard with the @commitlint/config-conventional. Recommanded: Use git cz to build conventional commit messages.

Developer Certificate of Origin (DCO)

Due to legal reasons, contributors will be asked to accept a DCO before they submit the first pull request to this projects, this happens in an automated fashion during the submission process. SAP uses the standard DCO text of the Linux Foundation.