Skip to content
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
110 lines (60 sloc) 2.54 KB

Contributing to ZeffClient

Thank you for taking the time to contribute!

This contains guidlines for contributing to ZeffClient. Mostly these are strong recommendations, but not rules. Feel free to propose changes to this document with a pull request.

Code of Conduct

That which is hateful to you, do not do to your neighbor (Hillel the Elder).

How Can I Contribute?

Reporting Bugs

Bug reports may be made in the project's issue page.

Suggesting Enhancements

Enhangement requests may be made in the project's issue page.

Pull Requests

  1. make validate
    • Should be executed before any commit is created.
    • Continuous integration will execute this command on any pull request.
    • Continuous integration will reject a pull request that fails.


Git Commit Messages

  • Use present tense (e.g. "Add fubar" not "Added fubar").

  • Use imperative mood (e.g. "Move cursor to…" not "Moves cursor to…").

  • Limit the first line to 72 characters or less.

  • Reference issues and pull requests after the first line (e.g. "fixes #1234").

  • Start commit message with an applicable emoji:

    Commit Type










    Code Structure


Python Styleguide

Documentation Styleguide

Additional Notes

You can’t perform that action at this time.