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

Improve Documentation for Better Contributor Onboarding #28

Open
ajaynegi45 opened this issue Sep 5, 2024 · 8 comments
Open

Improve Documentation for Better Contributor Onboarding #28

ajaynegi45 opened this issue Sep 5, 2024 · 8 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers gssoc GirlScript Summer Of Code gssoc-ext hacktoberfest hacktoberfest-accepted level2 GirlScript Summer Of Code - 25 points status: ready for dev You can asked for this issue to be assigned (if not already assigned)

Comments

@ajaynegi45
Copy link
Owner

Description:

The current documentation for the LibraryMan project lacks clarity in certain areas, making it difficult for new contributors to understand the codebase and contribute effectively. This issue involves updating and enhancing the existing documentation to improve the contributor experience.

Tasks:

  • Review the existing documentation and identify areas that need improvement.
  • Add detailed explanations of key features and modules within the project.
  • Ensure proper formatting and structure for easy navigation.
  • Include steps for setting up the development environment and running the project locally.
  • Create guidelines on how to contribute (pull request process, coding standards, etc.).

Expected Outcome:

  • The documentation should be comprehensive and easy to follow for new contributors.
  • Contributors should be able to understand the project's structure, code logic, and contribution process without confusion.
@ajaynegi45 ajaynegi45 added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest-accepted hacktoberfest status: ready for dev You can asked for this issue to be assigned (if not already assigned) labels Sep 5, 2024
@ajaynegi45 ajaynegi45 pinned this issue Sep 5, 2024
@ajaynegi45 ajaynegi45 added the gssoc GirlScript Summer Of Code label Oct 1, 2024
@Itachii27
Copy link

Hi @ajaynegi45 I would like to to work on this issue. Kindly assign this issue to me

@ajaynegi45
Copy link
Owner Author

Description:

The current documentation for the LibraryMan project lacks clarity in certain areas, making it difficult for new contributors to understand the codebase and contribute effectively. This issue involves updating and enhancing the existing documentation to improve the contributor experience.

Tasks:

  • Review the existing documentation and identify areas that need improvement.
  • Add detailed explanations of key features and modules within the project.
  • Ensure proper formatting and structure for easy navigation.
  • Include steps for setting up the development environment and running the project locally.
  • Create guidelines on how to contribute (pull request process, coding standards, etc.).

Expected Outcome:

  • The documentation should be comprehensive and easy to follow for new contributors.
  • Contributors should be able to understand the project's structure, code logic, and contribution process without confusion.

Hi @Itachii27,

Thank you for expressing your interest in working on the "Improve Documentation for Better Contributor Onboarding" issue. I'm delighted to inform you that I have assigned this issue to you. Your willingness to contribute to our project is much appreciated.

Feel free to start working, and if you have any questions or need assistance during the process, please don't hesitate to reach out.

@Itachii27
Copy link

Hi @ajaynegi45 I have done. Kindly review the PR and kindly add gssoc-extd label.

@jiwansh
Copy link

jiwansh commented Oct 2, 2024

Pls assign it to me @ajaynegi45 Sir

@Itachii27
Copy link

Pls assign it to me @ajaynegi45 Sir

I am already working on it @jiwansh

@ajaynegi45 ajaynegi45 added level2 GirlScript Summer Of Code - 25 points gssoc-ext labels Oct 2, 2024
@ajaynegi45 ajaynegi45 mentioned this issue Oct 5, 2024
1 task
@shauryaq05
Copy link

Please assign it to me and give me a chance

@ayushdubey570
Copy link

hey @ajaynegi45 i woud to do the documentation work, please assign this wok to me as i have done documentation work earlier

@ajaynegi45
Copy link
Owner Author

hey @ajaynegi45 i woud to do the documentation work, please assign this wok to me as i have done documentation work earlier

@ayushdubey570 Start working on it

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 gssoc GirlScript Summer Of Code gssoc-ext hacktoberfest hacktoberfest-accepted level2 GirlScript Summer Of Code - 25 points status: ready for dev You can asked for this issue to be assigned (if not already assigned)
Projects
None yet
Development

No branches or pull requests

5 participants