libturpial needs your help

Do you want to begin to contribute into libturpial codebase but you don’t know where to start?, that’s ok, it also happens to me sometimes, but today, the reality is that we need your help to fix some errors reported by our style checker (flake8), this errors are:

  • E126: continuation line over-indented for hanging indent
  • E128: continuation line under-indented for visual indent
  • E231: missing whitespace after :
  • E251: unexpected spaces around keyword / parameter equals
  • E261: at least two spaces before inline comment
  • E301: expected 1 blank line
  • E302: expected 2 blank lines
  • E303: too many blank lines
  • E501: line too long
  • E711: comparison to None should be if cond is not None:
  • E712: comparison to False should be if cond is False: or if not cond:
  • F401: imported but unused
  • F403: unable to detect undefined names
  • F821: undefined name
  • F841: local variable is assigned to but never used
  • F999: syntax error in doctest
  • W291: trailing whitespace
  • W391: blank line at end of file
  • W601: .has_key() is deprecated, use in

As you can see, some errors are really easy to fix but are too many for us, so please, we desperately need your help, help us!

The following is how we expect the community can contribute code into libturpial via Pull Requests.

1) If you don’t have a Github account, please create one first.

2) Fork our project

3) Install Git, after that you should setup your name and email:

    $ git config --global user.name "Your Name, not your Github nickname"
    $ git config --global user.email "[email protected]"
    

4) Set your local repository

    $ git clone https://github.com/your_github_nickname/libturpial.git
    

5) Set satanas/libturpial as your upstream remote, this basically tells Git that your are referencing libturpial’s repository as your main source.

    $ git remote add upstream https://github.com/satanas/libturpial.git
    

5.1) Update your local copy

    $ git fetch upstream
    

6) Verify that no one else has been working on the same bug, you can check that in our issues list, in this list you can also check Pull Requests pending for the BDFL approval.

7) Working on a bug

7.1) In the first place, install tox

    $ pip install tox
    

7.2) Then, create a branch that identifies the bug that you will begin to work on:

    $ git checkout -b E231 upstream/development
    

In this example we are working on the bugs of the type: E231 (as indicated by our style checker, flake8)

7.3) Make some local changes and commit, repeat.

7.3.1) Delete the error code that you will begin to work from the ignore list located at the flake8 section in the tox.ini file (located at the root of the project)

Example:

    # Original list:
    ignore = E126,E128,E231,E251,E261,E301

    # After we decide to work in the E231 error:
    ignore = E126,E128,E251,E261,E301
    

7.3.2) Execute tox -e py27 to check the current errors.

7.3.3) Fix, fix, fix…

7.3.4) Commit your changes

    $ git commit -m "Fixed errors 'E231' according to flake8."
    

7.4) In the case that you fixed all errors of the same type, please delete the corresponding line in the tox.ini file (located at the root of the project)

7.4.1) Don’t forget to commit that.

8) Publish your work

    $ git push origin E231
    

Please, adjust the name E231 to something more appropiate in your case.

9) Create a Pull Request and don’t hesitate to bug the main maintainer until your changes get merged and published. Last but not least, don’t forget to add yourself as an author in the AUTHORS file, located at the root of the project.

10) Enjoy your work! :-)

If you want to help us more than you did already you can check our issues list, also, you can check out the Turpial project, our light, fast and beautiful microblogging client written in Python, currently supports Twitter, and identi.ca.

You can find more details on our guide, also, in case of doubt don’t hesitate to reach us.

About libturpial

libturpial is a Python library that handles multiple microblogging protocols. It implements a lot of features and aims to support all the features for each protocol. At the moment it supports Twitter and Identi.ca and is the backend used for Turpial.

About Turpial

Turpial is an alternative client for microblogging with multiple interfaces. At the moment it supports Twitter and Identi.ca and works with Gtk and Qt interfaces.