Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 1.3 KB

CONTRIBUTING.md

File metadata and controls

35 lines (27 loc) · 1.3 KB
Raw

Contributing

You can help out by:

  • Solving existing issues.
  • Enhancing the bot adding more functionality (see issues)
  • Pointing out bugs/errors.

For above option(s), please create an issue so it can be addressed. New to GitHub issues? They have a pretty handy guide you can use to familiarize yourself with them.

If you can make a change

What you will need:

  • Your own Twitter account for testing
  • API Keys for Twitter.
    • Get your Twitter API keys here.
  • Fork the repository.
  • Add API keys to .env file, your .env file should look something like this:
CONSUMER_KEY=xxxxxxxxxxxxxxxxxxxxdMhxg
CONSUMER_SECRET=xxxxxxxxxxxxxxxxxxxxkFNNj1H107PFv1mvWwEM6CZH0fjymV
ACCESS_TOKEN=xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxecKpi90bFhdsGG2N7iII
ACCESS_TOKEN_SECRET=xxxxxxxxxxxxxxxxxxxxZAU8wNKAPU8Qz2c0PhOo43cGO
QUERY_STRING=#someTestHashTag
RESULT_TYPE=mixed
LANG=en
TWITTER_USERNAME=YourTestAccountUserName
TWITTER_RETWEET_RATE=120
  • Make your suggested change.
  • Make sure the code style looks similar to the existing code.
  • Create a pull request.