Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 2 KB

How to contribute to the OsoMeTweet package

Questions?

  1. Check the Wiki, we have a lot of documentation.
  2. Problem not solved in the Wiki?
    1. Check if the question has been asked/answered already by searching the issues
    2. If it hasn't, open an issue

Found a bug?

  1. Check that the bug hasn't been reported already by searching the issues.
  2. If it hasn't, please open an issue and let us know.

Looking for a specific feature?

  1. Check that we're not already working on this by searching the issues.
  2. If we are not, please open an issue and we'll try to get to it. Or, if you're up to it:
    1. Open an issue about this new feature
    2. Leave a comment informing us that you'll be tackling it on your own and assign yourself the issue
    3. Make a pull request with the changes that you'd like to include

Contribution Must-Haves:

Pull Requests

All pull requests should (where applicable)

  • Be Functional (aka, it should work without breaking anything else)
  • Include a thorough docstring with a description and the following sections: Parameters, Returns, Exceptions (copy format from existing api docstrings)
  • Include comments, docstrings, etc. that explain non-obvious portions of the code and increase usability of the feature/package (see Coding Conventions below)
  • Include tests within the tests.py file
  • Include only one feature per request
  • Include a summary of the changes in the initial PR and commit messages for every commit

We also love the Wiki.

Make sure to include helpful descriptions of how to use your new feature in a Wiki page.

Coding Conventions:

Take a look at the code and you'll see a very consistent format, style, and structure. This style intends to optimize the user's experience with the packge (Holy Batman! Look at those docstrings!) as well as the programmer's experience (readability and comments > one-liners and short code). Code contributions should do the same.