DenverCoder1 / github-readme-youtube-cards

Workflow for displaying recent YouTube videos as SVG cards in your readme
https://ytcards.demolab.com
MIT License
197 stars 46 forks source link

Implement recommended community standards to the project #34

Closed orama254 closed 2 years ago

orama254 commented 2 years ago

Hello @DenverCoder1

I was going though this project and noticed that there are some missing items based on the Github Community Standards recommendations that would make the project contributor friendly, e.g. a code of conduct, a contributing guide file, an issue template and a pull request template.

Let me know if this is something you would like to implement on this project.

ChinmayMhatre commented 2 years ago

I could work on adding the templates.

DenverCoder1 commented 2 years ago

Sure, I have some other projects with these files that the ones for this project can be based on

https://github.com/DenverCoder1/github-readme-streak-stats
https://github.com/DenverCoder1/readme-typing-svg
https://github.com/DenverCoder1/custom-icon-badges

Of course as this is a Python project, some things will be different.

As far as contributing and testing instructions, there is some info at the end of the readme currently that could be used.

orama254 commented 2 years ago

Ok @DenverCoder1, could you also assign either @ChinmayMhatre or I the task to implement this?

DenverCoder1 commented 2 years ago

Feel free to make a pull request :+1:

ChinmayMhatre commented 2 years ago

Hey @DenverCoder1 , Would you want the user to be able to make a blank issue template?

DenverCoder1 commented 2 years ago

I think an option for blank issues is fine as it sometimes makes it easier

I think the standard templates usually include Bug Report, Feature Request, Question (you can see the repos linked above as an example). If you have ideas to make it even better, feel free to suggest, though.

ChinmayMhatre commented 2 years ago

In addition to those maybe a template for documentation changes?

DenverCoder1 commented 2 years ago

Sure, if you'd like