all contributors bot!

[ryansurf]

@K-dash #83

Setup for the all-contributors bot to work

Added instructions for how to use the bot in CONTRIBUTING.md

.all-contributorsrc is the config file, specified here

Summary by Sourcery

Integrate the all-contributors bot to manage and display project contributors. Update README.md to include the all-contributors badge and placeholder for the contributors list.

Documentation:

• Added instructions in CONTRIBUTING.md on how to use the all-contributors bot.

Chores:

• Configured the all-contributors bot by adding .all-contributorsrc file.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request integrates the All Contributors bot into the project. The README.md file was updated to include a badge and placeholders for the contributors list, which will be managed by the bot. Additionally, CONTRIBUTING.md was updated with instructions on how to use the bot to add oneself to the contributors list.

File-Level Changes

Files	Changes
README.md CONTRIBUTING.md	Integrated the All Contributors bot by updating the README.md with a badge and placeholders for the contributors list, and added usage instructions in CONTRIBUTING.md.

---

Tips

• Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
• Continue your discussion with Sourcery by replying directly to review comments.
• You can change your review settings at any time by accessing your dashboard:
  • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
  • Change the review language;
• You can always contact us if you have any questions or feedback.

[sourcery-ai]

Hey @ryansurf - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider keeping the existing contributor recognition alongside the new all-contributors setup until the new system is fully populated to ensure no contributors are temporarily unlisted.
• The changes in README.md remove the current contributor display. Ensure that this transition doesn't inadvertently remove recognition for existing contributors.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟡 Documentation: 1 issue found

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.}

[sourcery-ai]

issue (documentation): Typo in 'youself'

The word 'youself' should be corrected to 'yourself'.

[github-actions]

Coverage Report

File	Stmts	Miss	Cover	Missing
src
__init__.py	0	0	100%
api.py	119	7	94%	32–36, 54, 76–77, 109–110
art.py	9	3	67%	32–33, 36
cli.py	25	3	88%	26, 55–56
dev_streamlit.py	37	37	0%	1–86
gpt.py	10	6	40%	16–21, 32–45
helper.py	179	76	58%	55, 57, 59, 61, 63, 65, 67, 69, 71, 73, 75, 77, 79, 81, 83, 85, 97, 108–112, 138, 140, 142, 144, 146, 158–180, 192, 205–206, 224–226, 236, 238–239, 262–263, 323–333, 340–348
send_email.py	24	24	0%	5–48
server.py	47	10	79%	55, 68–71, 87–91, 103–105
settings.py	22	0	100%
streamlit_helper.py	33	33	0%	5–90
TOTAL	505	199	61%

Tests	Skipped	Failures	Errors	Time
10	0 💤	0 ❌	0 🔥	20.785s ⏱️

[K-dash]

LGTM🚀

As the next step,
I think we need to add all the contributors so far, can we call the bot on this PR?

[K-dash]

https://allcontributors.org/docs/en/emoji-key

I see that we can also set Contribution Types when we call the bot, should we add this setting as an operational rule?

[ryansurf]

https://allcontributors.org/docs/en/emoji-key

I see that we can also set Contribution Types when we call the bot, should we add this setting as an operational rule?

I think the contribution setting is automatically applied, how do we make it optional? I might be a little silly right now but i don't see it

[K-dash]

@all-contributors please add @ryansurf for code and doc

[allcontributors]

@K-dash

I've put up a pull request to add @ryansurf! 🎉

[K-dash]

@ryansurf
The README.md is looking great! Thanks🥳