contributing.md

#Contibuting to FindMeBot

Welcome contributors to the project:

Short Links to Important Resources:

• docs: https://www.microsoft.com/cognitive-services/en-us/face-api
• https://dev.groupme.com/docs/v3
• bugs: Report bugs to krenner2@illinois.edu or ziweiba2@illinois.edu
• communcations: https://app.groupme.com/join_group/29262968/FpQAdO

Testing

• We may have unit testing at a later date

Development environment details

• Anything with Python works

How to submit changes:

• Make a pull request
• Get Ziwei/Kevin + one other contributor to look at your changes. Two thumbs up = okay

How to report a bug:

• Templates:
  • Name, issue, [optional] branch, [optional] file name
• First bugs for Contributors
  • Recognizing wrong face
  • Key doesn't work

New Feature Requirements

Email Ziwei or Kevin, make a pull request

Style Guide / Coding conventions

Comment your code! Put function params and returns, and try to comment sections in your methods too! It makes debugging easier

Code of Conduct

Recognition model

We will have a page with a list of contributors

Where can I ask for help?

StackOverflow