Skip to content

Latest commit

 

History

History
43 lines (27 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

43 lines (27 loc) · 1.77 KB

Contributing

Thank you for looking to contribute to SonarDelphi! GitHub issues and pull requests are the core locations for community involvement.

How to contribute

Reporting bugs

Please report bugs via GitHub issues.

When reporting a bug, please do the following:

  • Check that your issue has not already been reported
  • Include the versions of SonarDelphi and SonarQube you are using
  • Be as specific as possible in your description
  • If applicable, supply a minimal case that replicates the issue

Proposing features or improvements

Please propose new features via GitHub issues.

When proposing a feature, please do the following:

  • Check that a similar feature has not already been requested
  • Be as specific as possible in your description

There are no guarantees that a developer will decide to implement the feature - if you would like a feature, consider implementing it yourself and making a pull request.

Contributing pull requests

Pull requests are welcome!

When making a pull request, please do the following:

  • Ensure that the functionality is generally useful rather than specific to your use case
  • For new features, ensure that it has been proposed and discussed in an issue prior to making the pull request
  • Describe the contents of your pull request
  • Clearly explain the rationale for adding it to SonarDelphi
  • If you are implementing a rule, follow the workflow for adding new rules

Please note that SonarDelphi uses a rebase workflow, so PRs should have a clean and linear history.