sqlmapproject/sqlmap
1
1
Fork 0
mirror of https://github.com/sqlmapproject/sqlmap.git synced 2024-11-22 17:46:37 +03:00
Code Issues Packages Projects Releases Wiki Activity
65306f1ac1
sqlmap/CONTRIBUTING.md
Bernardo Damele 13a1baef20 Create CONTRIBUTING.md
2012-12-06 02:53:03 -08:00

3.8 KiB
Raw Blame History

Contributing to sqlmap

Reporting bugs

Bug reports are welcome! Please report all bugs on the issue tracker or, alternatively, to the mailing list.

Guidelines

  • Before you submit a bug report, search both open and closed issues to make sure the issue has not come up before. Also, check the user's manual for anything relevant.
  • Make sure you can reproduce the bug with the latest development version of sqlmap.
  • Your report should give detailed instructions for how to reproduce the problem. If sqlmap raises an unhandled exception, the traceback is needed. Details of the unexpected behaviour are welcome too. A small test case (just a few lines) is ideal.
  • If you are making an enhancement request, lay out the rationale for the feature you are requesting. Why would this feature be useful?
  • If you are not sure whether something is a bug, or want to discuss a potential new feature before putting in an enhancement request, the mailing list is a good place to bring it up.

Submitting code changes

All code contributions are greatly appreciated. First off, clone the Git repository, read the user's manual carefully, go through the code yourself and drop us an email if you are having a hard time grasping its structure and meaning. We apologize for not commenting the code enough - you could take a chance to read it through and improve it.

Our preferred method of patch submission is via a Git pull request. Many people have contributed in different ways to the sqlmap development. You can be the next!

Guidelines

In order to maintain consistency and readability throughout the code, we ask that you adhere to the following instructions:

  • Each patch should make one logical change.
  • Wrap code to 76 columns when possible.
  • Avoid tabbing, use four blank spaces instead.
  • Before you put time into a non-trivial patch, it is worth discussing it on the mailing list or privately by email.
  • Do not change style on numerous files in one single pull request, we can discuss about those before doing any major restyling, but be sure that personal preferences not having a strong support in PEP 8 will likely to be rejected.
  • Make changes on less than five files per single pull request - there is rarely a good reason to have more than five files changed on one pull request, as this dramatically increases the review time required to land (commit) any of those pull requests.
  • Style that is too different from main branch will be ''adapted'' by the developers side.
  • Do not touch anything inside thirdparty/ and extra/ folders.

Licensing

By submitting code contributions to the sqlmap developers, to the mailing lists, or via Git pull request, checking them into the sqlmap source code repository, it is understood (unless you specify otherwise) that you are offering the sqlmap project the unlimited, non-exclusive right to reuse, modify, and relicense the code. sqlmap will always be available Open Source, but this is important because the inability to relicense code has caused devastating problems for other Free Software projects (such as KDE and NASM). If you wish to specify special license conditions of your contributions, just say so when you send them.