hello-open-source icon indicating copy to clipboard operation
hello-open-source copied to clipboard

Difficult to follow contribution guidelines on readme

Open lovistawiah opened this issue 1 year ago • 4 comments

Describe the bug Following the contribution guidelines does not look beginner friendly. I believe instructions to be step-by-step guide that will aid beginners to contribute without sweating out. Using unordered list is really confusing, showing that one choose where to begin.

Expected behavior

  • I suggest it should be ordered list with screenshot or code blocks describing in detailed information the expected result from the contributor

Screenshots Screenshot from 2024-04-19 10-29-18

Desktop (please complete the following information):

  • OS: Ubuntu
  • Browser firefox

lovistawiah avatar Apr 19 '24 10:04 lovistawiah

I think the exact same. It is also misleading that it is not described exactly how to do shit. Instead there are always just links to another site where the user has to read it themselves.

Should I modify the readme file to solve the underlying problems?

lovistawiah avatar May 08 '24 23:05 lovistawiah

This is my first contribution, and I did not find it complicated. It is true that creating a branch is new for me, but I did not encounter a problem

turki013 avatar Mar 02 '25 19:03 turki013

@lovistawiah please check my pull request.

ShrutiShahi18 avatar May 22 '25 19:05 ShrutiShahi18