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

Better docs #3

Open
dnafication opened this issue Sep 22, 2024 · 14 comments · May be fixed by #7
Open

Better docs #3

dnafication opened this issue Sep 22, 2024 · 14 comments · May be fixed by #7
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed

Comments

@dnafication
Copy link
Owner

dnafication commented Sep 22, 2024

The current documentation is missing some key details and could be improved for better clarity and completeness.

@dnafication dnafication added documentation Improvements or additions to documentation good first issue Good for newcomers labels Sep 22, 2024
@dnafication dnafication added help wanted Extra attention is needed hacktoberfest labels Sep 30, 2024
@mendoncamaria
Copy link

Hi. I would like to take this issue up. Thank you.

@dnafication
Copy link
Owner Author

@mendoncamaria this is the inspiration for this app. See if you can link any other resources. :)

@mendoncamaria
Copy link

@mendoncamaria this is the inspiration for this app. See if you can link any other resources. :)

This suffices. I will take reference and raise a PR. We can carry it ahead from there. Thank you!!

@subhamagarrwal
Copy link

could i work on this issue??

@mendoncamaria
Copy link

@dnafication , i did observe the contributing guidelines for your project is missing. If it's ok with you, can you create an issue for it and assign keep it open? @subhamagarrwal can take that up I feel.

@subhamagarrwal
Copy link

@mendoncamaria I'll take it

@dnafication
Copy link
Owner Author

There's a contributing guide but it's very basic. Feel free to update and open a pull request. Happy to review and accept

https://github.com/dnafication/talk-timer/blob/main/CONTRIBUTING.md

@dnafication
Copy link
Owner Author

Try setting up the project locally and explore. See what else can be done for this simple app 🙂

@dnafication
Copy link
Owner Author

@mendoncamaria @subhamagarrwal are you guys making any progress with this? :) it's all good if not, we're not in hurry. Just reminding since Hacktoberfest will close end of this month.

@subhamagarrwal
Copy link

I'm really sorry I've been facing some personal issues of late by today I'll try and get a pr

@mendoncamaria
Copy link

Hi @dnafication will submit a PR today by EOD for the same. Was having some urgent work commitments, didn't get time to raise a PR.

@mendoncamaria mendoncamaria linked a pull request Oct 18, 2024 that will close this issue
2 tasks
@mendoncamaria
Copy link

Hi @dnafication Have raised a PR. Please check and let me know if you need any more data or changes

@subhamagarrwal
Copy link

@dnafication raised a PR.Kindly look into it.Completed it beforehand but there were some issues so couldnt do earlier

@subhamagarrwal
Copy link

@dnafication is it OK?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants