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

documentation #28

Closed
priyanshaggarwal001 opened this issue Oct 2, 2024 · 3 comments · Fixed by #45
Closed

documentation #28

priyanshaggarwal001 opened this issue Oct 2, 2024 · 3 comments · Fixed by #45

Comments

@priyanshaggarwal001
Copy link
Contributor

priyanshaggarwal001 commented Oct 2, 2024

hey @Amna-Hassan04 I would really liked to add a license file and also a documentation file containing the explanation of each line of code so it is easy to understand for developers

@priyanshaggarwal001
Copy link
Contributor Author

I would also like to add one more file containing the template for GitHub issue so that who is resolving it will be easy to understand what type of issue it was and how it solved everything

@Amna-Hassan04
Copy link
Owner

Amna-Hassan04 commented Oct 2, 2024

@priyanshaggarwal001 sure, you can add the license file, and documentation but dont make it very microscopic, I mean maybe dont explain every line of code, just write the main features and how we have implemented them in code etc. as for the template of github issue, raise a separate issue here and ask to add in some instructions like. problems screenshot, details, if someone is proposing a new feature they have to list down features properly also attach a screenshot of how the project should look like afterwards (can attach screenshot for any other project that has that functionality that they wanna implement). I will assign it to you. this issue template is important so consider working on this before I will assign you "task2" points for this one.

@priyanshaggarwal001
Copy link
Contributor Author

hey @Amna-Hassan04 I have completed both the issues and put it in pr also just the review is left and one more thing if possible in pr could u add the tages for gssoc and everything .
I enjoyed the work and challenges and for the screenshot mandatory I have tried to put the workflow file which according to me is correct but might be having few bugs which I am not able to catch so It would be very helpful like u can assign someone else to check the code and do few changed

@Amna-Hassan04 Amna-Hassan04 linked a pull request Oct 5, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants