Skip to content

Latest commit

 

History

History
78 lines (57 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

78 lines (57 loc) · 3.51 KB
Raw

How to Contribute

We're excited that you're interested in contributing to Credential Digger! Your contribution can make this project even better. Please read the guidelines regarding contributions:

How to report an issue

If you find a bug or some other issue with any part of the library, please submit an issue. Before doing so, please make sure that:

  • The issue is not a duplicate issue.
  • The issue has not been fixed in a newer release of the library.
  • The issue is reproducible.
  • Your explanation is clear and complete.
  • You provide example code and/or screenshots (recommended).

If you meet the above criteria, you can submit issues with our GitHub issue tracker. Please categorize your issue.

How to request a feature

You can also use the issue tracker to request a new feature or enhancement. Even if you want to implement the feature yourself, please first submit an issue detailing your proposal so that we may discuss it with you and the community before moving forward. Please categorize your issue with the proposal (green) label.

How to contribute code

You are welcome to contribute code to Credential Digger in order to fix issues or to add new features.

Contribution process

  • Check the develop branch and make sure that the issue/feature you want to work on has not been solved yet.
  • Fork the Credential Digger repository to your GitHub account.
  • You must follow the coding style as best you can when submitting code. Take note of naming conventions, separation of concerns, and formatting rules.
    • For Python (i.e., the main programming language used in this project), follow the pep8 style guide. You can use code fixers to handle this in a simple way (we suggest autopep8 and yapf).
  • Create a Pull Request from your forked repository to github.com/SAP/credential-digger. In the subject of the pull request, briefly describe the bug fix or enhancement you're contributing. In the pull request description, please provide a link to the issue in the issue tracker.
  • Follow the link posted by the CLA assistant to your pull request and accept the DCO.
  • Wait for our code review and approval. We may ask you for additional commits, or make changes to your pull request ourselves. Please be patient!
  • Once the change has been approved, we inform you in a comment.
  • We close the pull request. You can then delete the now obsolete branch.

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.

Contributing with AI-generated code

As artificial intelligence evolves, AI-generated code is becoming valuable for many software projects, including open-source initiatives. While we recognize the potential benefits of incorporating AI-generated content into our open-source projects there a certain requirements that need to be reflected and adhered to when making contributions.

Please see SAP's guideline for AI-generated code contributions to SAP Open Source Software Projects for these requirements.