Skip to content
This repository has been archived by the owner on Oct 31, 2023. It is now read-only.

Commit

Permalink
Create Contributing.md 📝
Browse files Browse the repository at this point in the history
  • Loading branch information
spences10 authored Jun 26, 2017
1 parent 8e4aaee commit ede6aa6
Showing 1 changed file with 0 additions and 37 deletions.
37 changes: 0 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
- [Node dependencies](#node-dependencies)
- [Deploy with now](#deploy-with-now)
- [Handy tip](#handy-tip)
- [Contributing](#contributing)
- [Links](#links)
- [License](#license)

Expand Down Expand Up @@ -213,42 +212,6 @@ I have added my most used git commands I use in this [repo][cheetsheets] I use i
<!--link-->
[cheetsheets]: https://github.com/spences10/cheat-sheets/blob/master/git.md

## Contributing

You can help out by:

- Solving existing [issues](https://github.com/spences10/twitter-bot-bootstrap/labels/bug).
- Enhancing the bot adding more functionality [(see issues)](https://github.com/spences10/twitter-bot-bootstrap/labels/enhancement)
- 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](https://twitter.com/signup) for testing
- API Keys for Twitter.
- Get your Twitter API keys [here](https://apps.twitter.com/app/new).
- [Fork](https://github.com/spences10/twitter-bot-bootstrap) the repository.
- Add API keys to `.env` file, your `.env` file should look something like this:

```shell
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.

## Links

Credit for the inspiration for this should go to [@amanhimself](https://twitter.com/amanhimself) and his posts on creating your own twitter bot.
Expand Down

0 comments on commit ede6aa6

Please sign in to comment.