CONTRIBUTING.md (2385B)
1 # If you have a question or found a bug 2 3 To ask a question about the package, please please [create an 4 issue][gh-issue-link] containing a description of what you are trying to do 5 and consider providing sample SQL code if appropriate. There is also a 6 [manual](./sql-indent.org) which provides information about customizing the 7 indentation rules. 8 9 If you found a bug in the SQL indentation code, or don't know how to configure 10 the indentation rules to suit your preferences, please [create an 11 issue][gh-issue-link]. Please provide a sample SQL code snippet that 12 demonstrates the problem. 13 14 # Submitting code changes 15 16 The preferred way to accept contributions is to submit a pull request using 17 GitHub. Before doing so, you need to be aware of the copyright assignment 18 requirements and the automated test-suite. These are detailed in the sections 19 below. 20 21 ## Copyright Assignment 22 23 This package is part of [GNU ELPA][elpa-link] and it is subject to the GNU 24 [Copyright Assignment][copy-papers-link] policy. Any [legally 25 significant][legally-link] contributions can only be accepted after the author 26 has completed their paperwork. Please see [the request form][request-link] if 27 you want to proceed with the assignment. 28 29 ## Automated test suite 30 31 There's an automated test suite which is used to ensure we don't re-introduce 32 bugs that that were already fixed. If you fix the problem with the 33 indentation, please provide an automated test for your fixes and add it to the 34 test suite. The "Commentary" section in the 35 [sql-indent-test.el](./sql-indent-test.el) file contains a description on how 36 to add and run tests. 37 38 ## Other considerations for the pull request 39 40 In your pull request, please provide a clear description of what the changes 41 do and add a sample SQL snippet that illustrates the problem being solved. 42 43 Once you submit the pull request, an automated build will start and will run 44 the unit tests, please verify that the build succeeds and fix any issues if 45 the build failed. 46 47 [elpa-link]: http://elpa.gnu.org/packages/ 48 [copy-papers-link]: http://www.gnu.org/prep/maintain/html_node/Copyright-Papers.html 49 [legally-link]: http://www.gnu.org/prep/maintain/html_node/Legally-Significant.html#Legally-Significant 50 [request-link]: http://git.savannah.gnu.org/cgit/gnulib.git/tree/doc/Copyright/request-assign.future 51 [gh-issue-link]: https://github.com/alex-hhh/emacs-sql-indent/issues 52