freeCodeCamp / 100DaysOfCode-twitter-bot

Twitter bot for #100DaysOfCode
https://twitter.com/_100DaysOfCode
BSD 3-Clause "New" or "Revised" License
283 stars 110 forks source link

Update docs to the KCD README pattern #131

Open spences10 opened 6 years ago

spences10 commented 6 years ago

README pattern

Optimal README layout from Kent Dodds source:

  1. Title + tagline + logo?
  2. Badges
  3. The problem
  4. The solution
  5. TOC
  6. Installation
  7. Usage
  8. FAQ
  9. Inspiration
  10. Alternatives
  11. Contributors
  12. License
amandeepmittal commented 6 years ago

I like this!

yashdev9274 commented 2 years ago

@spences10 is it still open

spences10 commented 2 years ago

It looks that way @yashdev9274 😊

yashdev9274 commented 2 years ago

can you please help me @spences10 , I 'm new to open source contribution

yashdev9274 commented 2 years ago

how should I start working on it

spences10 commented 2 years ago

Hey @yashdev9274, sure, I'd be happy to help. 😊

Not right now though, I'm not going to be around for the next couple of weeks.

I'm only checking in on GitHub intermittently and I'm sorry you've been left hanging here! 😬

So, if you're ok waiting I can walk though what needs to be done. Get in touch with me via Twitter or Discord, I'm part of the Eddie Hub Discord where you can message me. There's also a really large community there of people that will be able to help you too.

This could also be a separate PR to update the contributing guidelines too so you could get a double whammy for it.

There's also @amandeepmittal that may be able to help here, we're both not that active in this repo anymore but would be able to help out with any open source contributions.

amandeepmittal commented 2 years ago

@yashdev9274, as Scott said, we both right now are not active maintainers of this repo. However, you can get in touch with @zairahira as she putting in the effort to actively maintain it.

yashdev9274 commented 2 years ago

thank you @spences10 and @amandeepmittal for your help . I would really like to be in contact with you two

BTW I'm full-stake developer and ml engineer 3rd yr college student looking for remote job please let me know if there is any opportunity for me

here is my linkedin profile: www.linkedin.com/in/yash-dewasthale

yashdev9274 commented 2 years ago

are you @spences10 , @amandeepmittal currently working on any project i can help