Pairity
Installation
- Clone this project.
-
cd
into thepairity
directory. - Run
rake install
. - Run
pairity
. - Follow the instructions to setup Google Sheets and Slack integrations.
- Add people and then save your sheet (instructions below).
Usage
Generating Pairs
- Select Generate Pairs
- (Optional) Select Nope a Pair, if a you would like to regenerate the pairs without the selected pairing.
- Select Save & Slack to save the pairings and post them to your slack channel.
Adding People
- Run
pairity
in the terminal. - Select Edit People.
- Select Add.
- Enter their names, separated by commas:
Booba Khan, Fumbo Dango, Papa Trepé, Jane Smith
- Select Save Changes.
Removing People
- Run
pairity
in the terminal. - Select Edit People.
- Select Remove.
- Choose the person from the list.
- Select Save Changes
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pairity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.