Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

52 lines (39 loc) · 2.33 KB

If you have a question or found a bug

To ask a question about the package, please please create an issue containing a description of what you are trying to do and consider providing sample SQL code if appropriate. There is also a manual which provides information about customizing the indentation rules.

If you found a bug in the SQL indentation code, or don't know how to configure the indentation rules to suit your preferences, please create an issue. Please provide a sample SQL code snippet that demonstrates the problem.

Submitting code changes

The preferred way to accept contributions is to submit a pull request using GitHub. Before doing so, you need to be aware of the copyright assignment requirements and the automated test-suite. These are detailed in the sections below.

Copyright Assignment

This package is part of GNU ELPA and it is subject to the GNU Copyright Assignment policy. Any legally significant contributions can only be accepted after the author has completed their paperwork. Please see the request form if you want to proceed with the assignment.

Automated test suite

There's an automated test suite which is used to ensure we don't re-introduce bugs that that were already fixed. If you fix the problem with the indentation, please provide an automated test for your fixes and add it to the test suite. The "Commentary" section in the sql-indent-test.el file contains a description on how to add and run tests.

Other considerations for the pull request

In your pull request, please provide a clear description of what the changes do and add a sample SQL snippet that illustrates the problem being solved.

Once you submit the pull request, an automated build will start and will run the unit tests, please verify that the build succeeds and fix any issues if the build failed.