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

[Custom Issue]: Update and Improve Contributor Documentation #42

Closed
2 tasks done
Rucha-Ambaliya opened this issue Jan 10, 2025 · 1 comment · Fixed by #43
Closed
2 tasks done

[Custom Issue]: Update and Improve Contributor Documentation #42

Rucha-Ambaliya opened this issue Jan 10, 2025 · 1 comment · Fixed by #43
Assignees

Comments

@Rucha-Ambaliya
Copy link
Contributor

📝 Issue Description

Key sections of the documentation need updates to improve clarity and make the project more welcoming for new contributors:

  1. Current Implementation Status and Limitations
    • Needs to reflect recent changes and challenges.
  2. Priority Areas for Contribution
    • Should highlight new beginner-friendly, high-impact tasks aligned with project goals.
  3. Project Structure
    • Requires a clear, updated explanation to help contributors navigate the codebase.
  4. Contributor-Friendliness
    • Add resources like setup guides, workflows, and troubleshooting tips.

🎯 Expected Outcome

No response

📋 Additional Context

No response

📜 Confirmation

  • I have reviewed the existing issues to avoid duplication
  • I have provided sufficient detail for others to understand the issue
Copy link

👋 Thanks for opening this issue!

This issue has been automatically labeled with swoc and good first issue tags by our GitHub Actions bot 🤖.

Feel free to start working on this issue by:

  1. Commenting below to get assigned
  2. Creating a fork of the repository
  3. Making your changes in a new branch
  4. Opening a pull request

Need help? Join our Discord community!

This is an automated message from SocioSell's GitHub Actions bot 🦾

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