search

ChimeraCoder / anaconda

A Go client library for the Twitter 1.1 API
MIT License
1.14k stars 247 forks source link

added idea (goland) to gitignore and updated documentation #242 #243

Open liron-navon opened 6 years ago

liron-navon commented 6 years ago

Changes made:

On README.md

  1. Changed the examples syntax, kind of more welcoming to call variables tweet and values instead of t and v. "your-access-token" and "your-access-token-secret" are actually the user's token and secret, easier to understand this way if you are new to twitter's api.
  2. Added documentation for the filter streaming service and upload files.
  3. added link to the GoDoc
  4. added links to the appropriate twitter docs for each endpoint used in the readme to make it easier to understand and use.

On .gitignore

  1. added .idea to gitignore (file created by Intelij idea and Goland ide's)
muesli commented 6 years ago

@liron-navon: First of all, thanks for your PR!

There are a few issues with it however:

  1. Please group changes into individual commits. For example the documentation changes and .gitignore changes don't belong together and should be committed separately.
  2. Similarly, please open individual pull requests for changes that don't belong together.
  3. I don't think we should start adding IDE-specific files to .gitignore. You can add those to your personal, global gitignore file.
  4. You seem to have added a bunch of unnecessary whitespace to the README. Did this happen by accident? I'm not sure it makes the README more readable or less.

Please don't let this feedback discourage you, I really appreciate all the documentation updates!