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

add a contributions page to docs #42

Closed
amirfz opened this issue Jul 26, 2023 · 1 comment
Closed

add a contributions page to docs #42

amirfz opened this issue Jul 26, 2023 · 1 comment
Assignees

Comments

@amirfz
Copy link
Contributor

amirfz commented Jul 26, 2023

TEMPLATE:

Onboarding new developers to an open-source project is a crucial step to ensure they have a smooth and successful integration into the community. Here's a template for the onboarding process that you can adapt and customize based on your specific project's needs:
Subject: Welcome to [Your Open Source Project Name] - Onboarding Process
Dear [New Developer's Name],
Welcome to the [Your Open Source Project Name] community! We are excited to have you on board and contributing to our project. This email outlines the onboarding process to help you get started and become an active member of our open-source community.

  1. Project Overview:
    • Briefly introduce the project's purpose, goals, and target audience.
    • Share the project's mission and vision to give the new developer context.
  2. Contribution Guidelines:
    • Direct them to the project's contribution guidelines and code of conduct.
    • Emphasize the importance of following these guidelines to maintain a healthy and inclusive community.
  3. Communication Channels:
    • Provide a list of communication channels (e.g., Slack, Discord, mailing lists, forums) used by the community.
    • Explain the purpose of each channel and how to join them.
  4. Development Environment Setup:
    • Provide detailed instructions on how to set up the development environment.
    • Include links to any relevant tools, dependencies, or style guides.
  5. Codebase Overview:
    • Offer a high-level tour of the codebase to familiarize the new developer with the project's structure.
    • Point out essential directories, modules, and key components.
  6. Starter Tasks:
    • Suggest beginner-friendly tasks that new developers can work on to get started.
    • Provide links to any "good first issues" or "beginner-friendly" labels in the issue tracker.
  7. Mentoring/Buddy System:
    • Offer to pair the new developer with an experienced contributor (mentor/buddy) who can guide them through their first contributions.
    • Explain how they can reach out to a mentor if interested.
  8. Community Events:
    • Inform the new developer about any upcoming community events, such as meetings, workshops, or hackathons.
    • Encourage participation in these events to build connections and share knowledge.
  9. Recognition and Attribution:
    • Explain how the project recognizes and attributes contributions, such as through contributor badges, hall of fame, etc.
  10. Feedback and Questions:
  • Encourage the new developer to ask questions and seek help whenever needed.
  • Provide contact details of community managers or project leaders for further assistance.
    Thank you for joining our open-source community! We believe that your contributions will make a valuable impact on [Your Open Source Project Name]. If you have any questions or need assistance during the onboarding process, please don't hesitate to ask.
    Happy coding!
    Best regards,
    [Your Name]
    [Your Open Source Project Name]
    [Website/Repository URL]
    [Contact Email/Handle]
@20001LastOrder 20001LastOrder self-assigned this Aug 3, 2023
oshoma added a commit to oshoma/sherpa that referenced this issue Aug 18, 2023
This should be merged into Amir's broader "onboarding" docs.

Partially addresses Aggregate-Intellect#42.
@amirfz
Copy link
Contributor Author

amirfz commented Aug 22, 2023

PR #96

@amirfz amirfz closed this as completed Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants