CONTRIBUTING.md

Every contribution are welcomed as long as few rules are followed.

TL;DR

• Branch off devel.
• Only one feature per commit.
• In case of changes request, amend your commit to avoid multiple commits.
• Run make lint before and after coding and take care not to lower the rating.
• Write unit tests as much as possible so we can easily check your code.
• Run unit tests using make test before commiting.

How to contribute

• If you're thinking about a new feature, see if there's already an issue open about it or please open one otherwise.
• One commit per feature.
• Branch off the devel branch.
• Test your code with unit tests and use make test to run them all.
• Run make lint before and after coding and take care not to lower the rating. It worth mentioning you can freely improve the rating !
• If we ask for a few changes, please amend your commit rather than creting new commits.
• Remember to be Python 2.7 compliant.

How to start coding ?

First thing to do is to install dev requirements by running make install-dev-deps. Everything you need to start coding should be setup. To be sure everything went ok, run unit tests using command make test.

If needed, edit the config/settings.py so you can change logger level to debug (LOGGER['level'] and API['debug'] properties).

Branches

• master still contains a stable version of the code. Releases are tagged from this branch.
• devel contains all changes in the current development version. Don't use this code in production since it might break it.

Licensing for new files

ip-reputation-monitoring is licensed under GNU GPL v3 license. Anything contributed to ip-reputation-monitoring must be released under this license.

When introducing a new file into the project, please make sur it has a copyright header making clear under which licenses it's being released.