notsoocool / codecache

CodeCache is a dynamic web application designed to streamline the way developers manage and access code snippets. The platform provides a comprehensive library of code snippets, allowing users to save, organize, and retrieve useful code snippets for various programming languages and use cases.
https://codecache.tech
MIT License
18 stars 54 forks source link

Improve & Enhance the README #49

Closed yashksaini-coder closed 1 month ago

yashksaini-coder commented 1 month ago

Is your feature request related to a problem? Please describe. I want to create a single issue that will be used to add all the enhancement & improving components of the README. Without raising any duplicates errors

Describe the solution you'd like To add all the dynamic & integrating the action workflows to update & regenerate new contents and add them in the README

Describe alternatives you've considered Multiple action workflows that will share the job loads to create, generate & render components in the README

Additional context

github-actions[bot] commented 1 month ago

πŸŽ‰ Welcome to CodeCache! πŸŽ‰

Thank you for opening your first issue! We're excited to have you contributing to the project.

Before you get started, please make sure to check out our contributing guidelines and coding standards to ensure that everything is aligned with the project's workflow. If you have any questions or need help along the way, don't hesitate to ask.

We appreciate your input and look forward to collaborating with you. πŸš€

Happy coding!

yashksaini-coder commented 1 month ago

@notsoocool can you assign me this issue as a GSSOC contributor & add labels to this issue.

notsoocool commented 1 month ago

Sure, go ahead @yashksaini-coder, but please keep one thing in mind. While integrating the GitHub Action workflow, make sure to test it thoroughly in your local repository first. Once you're confident that it's working, then proceed to make a PR.

It would be a hassle for others if the workflow isn’t functioning properly, especially if it's directly pushed to the main branch. Let's avoid any disruptions for other contributors.

Thanks!

notsoocool commented 1 month ago

@yashksaini-coder can you tell me when will the contibutors list gets updated?

Screenshot 2024-10-08 at 2 04 32 PM

kindly check the github action

yashksaini-coder commented 1 month ago

You have to give permission in your repo to allow the workflows to generate & approve changes.

Check below:-

codecache-49.webm

yashksaini-coder commented 1 month ago

Also to include the updated changes of the successful workflow runs, I am raisin a new PR to update changes. Kindly review it & also add labels to it.

notsoocool commented 1 month ago

now its working but, its only showing 2 contributors kindlyy check the pr by the gihtub action and find the error, as i am not that experienced with Github Actions XD

yashksaini-coder commented 1 month ago

okh got it, I will check and raise a issue with the PR attached, assign it to me then

yashksaini-coder commented 1 month ago

now its working but, its only showing 2 contributors kindlyy check the pr by the gihtub action and find the error, as i am not that experienced with Github Actions XD

Because the contributions are really low, and those who have contributed there changes are still not merge so they are not detected by the action workflow. That's why the no. of contributors showing is only 2.

notsoocool commented 1 month ago

now its working but, its only showing 2 contributors kindlyy check the pr by the gihtub action and find the error, as i am not that experienced with Github Actions XD

Because the contributions are really low, and those who have contributed there changes are still not merge so they are not detected by the action workflow. That's why the no. of contributors showing is only 2.

Actually you can check in the repo contributors list, there are more than 6 contributors

yashksaini-coder commented 1 month ago

now its working but, its only showing 2 contributors kindlyy check the pr by the gihtub action and find the error, as i am not that experienced with Github Actions XD

Because the contributions are really low, and those who have contributed there changes are still not merge so they are not detected by the action workflow. That's why the no. of contributors showing is only 2.

Actually you can check in the repo contributors list, there are more than 6 contributors

Let me try some other alternatives to solve this issue, also I will be deleting the previous action workflow.

yashksaini-coder commented 1 month ago

@notsoocool I raised another PR that uses an alternative workflow with docker in behind. It is running successfully, and only uses one single-line marker

Check the PR #75 , add labels to it