Contributing to data-migrator

The following is a set of guidelines for contributing to data-migrator.

Submitting an Issue

Provide a small self sufficient code + data example to reproduce the issue.
Use the issue tracker to file the issue at github

If the problem cannot be reliably reproduced, the issue will be marked as question.

If the problem is not related to request the issue will be marked as help wanted.

In all of the cases your PR needs tests and documentation. Please add both if you add code
Run make test locally. Fix any errors before pushing to GitHub.
After submitting the PR a build will be triggered on Circle CI. Wait for it to ends and make sure all jobs are passing.
Check if code quality is retained at Codacy.

You can become a contributor, just make some valuable contributions and ask for it to become one.

There are a few basic ground-rules for contributors:

Commit messages reflect intent and all intent is documented in issues, even after the fact
Any change should be added through Pull Request, from a separate branch from master.
No --force pushes or modifying the Git history in any way.
Non-master branches ought to be used for ongoing work.
All modules, functions, and methods should be well documented reStructuredText for Sphinx AutoDoc with Google Napoleon conventions.
Rebase your PRs and preferably squash them.

Declaring formal releases remains the prerogative of the project maintainer.

Everyone interacting with this codebase, issue trackers, chat rooms, and mailing lists is expected to follow the Code of Conduct.