guilyx / secret-santa

🎄🎁 Random attribution of Secret Santas in a group via email, deletion of the sent emails. Can't cheat !

Setup

To setup the project on your local machine:

1. Click on Fork.
2. Go to your fork and clone the project to your local machine.
3. git clone https://github.com/Guilyx/secret-santa.git
4. pip3 install -r requirements.txt

Run

Simply run python3 src/main.py in the repo's root

Contribute

To contribute to the project:

1. Choose any open issue from here.
2. Comment on the issue: Can I work on this? and get assigned.
3. Make changes to your fork and send a PR.

To create a PR:

Follow the given link to make a successful and valid PR: https://help.github.com/articles/creating-a-pull-request/

To send a PR, follow these rules carefully, otherwise your PR will be closed:

1. Make PR title in this formats:

Fixes #IssueNo : Name of Issue

Feature #IssueNo : Name of Issue

Enhancement #IssueNo : Name of Issue

According to what type of issue you believe it is.

For any doubts related to the issues, i.e., to understand the issue better etc, comment down your queries on the respective issue.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Erwin Lejeune - @spida_rwin - [e-mail]

Contributors

Everyone part of the original team or that assisted throughout the development.

• Erwin Lejeune