Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs to the KCD README pattern #131

Open
spences10 opened this issue Mar 25, 2018 · 9 comments
Open

Update docs to the KCD README pattern #131

spences10 opened this issue Mar 25, 2018 · 9 comments

Comments

@spences10
Copy link
Collaborator

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
Copy link
Member

I like this!

@yashdev9274
Copy link

@spences10 is it still open

@spences10
Copy link
Collaborator Author

It looks that way @yashdev9274 😊

@yashdev9274
Copy link

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

@yashdev9274
Copy link

how should I start working on it

@spences10
Copy link
Collaborator Author

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
Copy link
Member

@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
Copy link

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants