EandrewJones commented on issue #505:
URL: 
https://github.com/apache/flagon-useralejs/issues/505#issuecomment-2637642713

   @krishna-dave206 You can absolutely pick this up.
   
   
   The first step is to attempt to follow the steps for setting up and using 
the project based on the README _as is_. Anywhere the directions are unclear or 
things do not work as written, we know that's a place we need to improve the 
documentation. Flag these and share here, so we can iterate with you to improve 
the docs.
   
    A secondary step, after we iterate through the above improvements, is to go 
through the existing README and test to see which links are broken (i.e. point 
to non-existent external websites or other sections of the README). Remove 
these or flag them and we can tell you whether there's a new, correct resource 
to point to. I'll try to find some time to make a pass and identify specific 
things I know are broken.
   
   Finally, we have a new `CONTRIBUTING.md` with much better guidelines about 
how to contribute to the project, but that's not well-reflected in the README. 
We should update the existing contributing section to point directly to our 
CONTRIBUTING.md.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@flagon.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@flagon.apache.org
For additional commands, e-mail: notifications-h...@flagon.apache.org

Reply via email to