Skip to content

Contributing

Infected Drake edited this page Nov 18, 2018 · 1 revision

Contributing to XSRFProbe

First of all thank you for your interest in XSRFProbe Development!

Conditions

You pull request must be satisfying one of these categories:

  • A new feature/enhancement.
  • Fix an issue/feature-request.
  • An improvement to existing modules.

Pull requests other than these (eg. adding a new banner) will NOT be entertained.

For New Pull Requests

  • Target your pull request to the master branch. Not any other branch.
  • Specify the Operating System and Python environment to make your pull request reproducible.
  • Refer whether this does add any new dependency or not.
  • Mention whether the new PR does add any new parameters to the existing set.
  • Include output, especially for witness-able effects in console.
  • Reference associated issues in your pull request description.
  • Don't leave your pull request description blank.
  • Don't abandon your pull request. Being responsive helps to land your code faster.
  • Test your build properly before submitting the PR.

Code Contribution Tips:

  • Try sticking to the Python PEP 8 style guide.
  • Your Python indentation should be 4 spaces. Please don't mess that up.
  • Do follow the 50/72 rule for Git commit messages.
  • Your code should be licensed under the same GPL v3 License.
  • Your code should be well documented so that folks will know whats going on under the hood.
  • Create a topic branch to work on instead of working directly on master. If you do not send a PR from a topic branch, the history of your PR will be lost as soon as you update your own master branch.

XSRFProbe Wiki Index

Clone this wiki locally