Skip to content

Latest commit

 

History

History
93 lines (61 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

93 lines (61 loc) · 3.88 KB
Raw

Contributing to Django-drip-campaigns

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

We Develop with Github

We use github to host code, to track issues and feature requests, as well as accept pull requests.

We Use Github Flow, So All Code Changes Happen Through Pull Requests

Pull requests are the best way to propose changes to the codebase (we use Github Flow). We actively welcome your pull requests:

  1. Fork the repo and create your branch from master.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

This is an example of a bug report. Here's another example from Craig Hockenberry, an app developer whom I greatly respect.

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can. My stackoverflow question includes sample code that anyone with a base Project setup can run to reproduce what I was seeing
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

For new feature proposals open a RFC

  • Open an issue with the tag RFC
  • Include the following sections in the issue description

    • What do you want and why?

    • How is this different from what you are currently doing?

    • Possible implementation

Use a Consistent Coding Style

I'm again borrowing these from Rootstrap Tech Guides

  • 4 spaces for indentation rather than tabs
  • You can try running flake8 . for style unification
  • In this project we decided to use the format() function for string formatting. We prefer to use f strings, but since we want to keep support for Python 3.5, we can't use that. Example:
x = 3
print('Number in var x is: {x}'.format(x=x))

Update the version

Before creating the pull request, please update the version in drip/__inti__.py following the next rules:

  • If you are doing a fix, then bump the third digit.
  • If you are doing a non breaking change, then bump the second digit.
  • If you are doing a breaking change, then bump the first digit.

We have travis-ci configured to automatically release the changes in master branch.

If you are doing changes in the docs, you have to:

  • Keep the version unchanged.
  • Make sure the branch name starts with docs/. For example: docs/update-drip-class-description.

License

By contributing, you agree that your contributions will be licensed under its MIT License.

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft