Skip to content
This repository was archived by the owner on Feb 4, 2025. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (29 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

35 lines (29 loc) · 2.7 KB
Raw

Contributing to Data Synthesis for Machine Learning

You are welcome to contribute code to the Data Synthesis for Machine Learning in order to fix bugs or to implement new features.

You must be aware of the Apache License (which describes contributions) and accept the Developer Certificate of Origin. This is common practice in major Open Source projects. To make this process as simple as possible, we are using CLA assistant for individual contributions. CLA assistant is an open source tool that integrates with GitHub very well and enables a one-click experience for accepting the CLA. For company contributors, special rules apply. See the respective section below for details.

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.

How to report an issue

If you find a bug, you are welcome to report it. Just create a new issue in our repository and give the detailed description and reproduce steps.

Issue handling process

When an issue is reported, we 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 assigned to a committer in GitHub. An issue that is about a real bug is closed as soon as the fix is committed.

How to Contribute

  1. Create a branch by forking the repository and apply your change.
  2. Commit and push your change on that branch.
    Commit Message Style: <commit-type>: <commit-description>
    • commit-type:
      • fix - a bug fix (note: this will indicate a release)
      • feat - a new feature (note: this will indicate a release)
      • docs - documentation only changes
      • style - changes that do not affect the meaning of the code
      • refactor - a code change that neither fixes a bug nor adds a feature
      • perf - a code change that improves performance
      • test - adding missing tests
      • chore - changes to the build process or auxiliary tools and libraries such as documentation generation
      • revert - revert to a commit
      • WIP - work in progress
    • commit-description: detail information of the commit
  3. Create a pull request in the repository.
  4. Follow the link posted by the CLA assistant to your pull request and accept it, as described above.
  5. Wait for our code review and approval, possibly enhancing your change on request.
  6. Once the change has been approved and merged, we will inform you in a comment.