Skip to content

ByteMyCV is an open-source, AI-powered resume analysis tool that provides structured insights, skill extraction, ATS scoring, and content evaluation. Built under Open Dev Society (ODS) to enable transparent, community-driven development.

License

Notifications You must be signed in to change notification settings

Open-Dev-Society/ByteMyCV

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

1 Commit
Β 
Β 

Repository files navigation

Open Dev Society - Contribution Guidelines

Welcome to Open Dev Society! πŸŽ‰

Thank you for your interest in contributing to Open Dev Society! We're building a vibrant community where everyone can contributeβ€”not just developers. Whether you write code, create content, teach, organize events, or simply have ideas to share, you belong here.


Table of Contents


Ways to Contribute

πŸ’» Code Contributions

Who this is for: Developers, programmers, software engineers, Innovators

What you can do:

  • Contribute a project to Open Dev Society, read Project Contribution Guidelines
  • Fix bugs or implement new features in our projects
  • Review pull requests and provide feedback
  • Improve code quality, performance, or security
  • Write tests or refactor existing code
  • Help with DevOps, CI/CD, or infrastructure

How to get started:

  1. Browse our Projects
  2. Look for issues labeled good first issue or help wanted
  3. Comment on an issue to let us know you're working on it
  4. Fork the repository, make your changes, and submit a pull request
  5. Follow our Code Style Guidelines (see project-specific CONTRIBUTING.md)

Helpful resources:


✍️ Content & Documentation

Who this is for: Technical writers, documentarians, bloggers, editors

What you can do:

  • Write or improve project documentation (README, tutorials, API docs)
  • Create guides, how-tos, or case studies
  • Proofread and edit existing content for clarity
  • Write blog posts about our projects or open-source topics
  • Improve accessibility of documentation
  • Create FAQs or troubleshooting guides

How to get started:

  1. Check our documentation repository or individual project docs
  2. Look for issues labeled documentation or content needed
  3. Identify gaps in documentation (missing tutorials, unclear explanations)
  4. Submit a pull request with your improvements or new content
  5. For blog posts, reach out to us at opendevsociety@cc.cc with your pitch

Content Guidelines:

  • Write in clear, simple language accessible to beginners
  • Use inclusive, welcoming tone
  • Include code examples, screenshots, or diagrams where helpful
  • Follow our Documentation Style Guide

πŸŽ“ Education & Teaching

Who this is for: Educators, teachers, mentors, trainers, instructional designers

What you can do:

  • Develop course materials, lesson plans, or learning paths
  • Create educational content (worksheets, exercises, quizzes)
  • Lead workshops or training sessions (virtual or in-person)
  • Mentor newcomers or students in open-source contributions
  • Design learning resources for different skill levels
  • Provide feedback on educational content

How to get started:

  1. Join our education working group (reach out via email or Discord)
  2. Check our Roadmap for upcoming educational initiatives
  3. Propose a workshop topic by opening an issue with the label workshop proposal
  4. Collaborate on curriculum development in our OpenDev Learn repository
  5. Volunteer as a mentor by filling out this form

Education Contribution Ideas:

  • Create a beginner-friendly tutorial for one of our tools
  • Develop a "Getting Started with Open Source" curriculum
  • Lead a workshop on contributing to GitHub projects
  • Mentor first-time contributors
  • Create video lessons or interactive learning modules

Resources for educators:


πŸŽ™οΈ Media & Creative

Who this is for: Podcasters, video creators, graphic designers, illustrators, photographers

What you can do:

  • Create podcast episodes about open-source topics or our projects
  • Produce video tutorials, demos, or walkthroughs
  • Design logos, graphics, illustrations, or marketing materials
  • Create social media content (posts, infographics, banners)
  • Edit videos or audio for community content
  • Photograph or create visuals for events

How to get started:

  1. Check our Roadmap for media initiatives
  2. Look for issues labeled media, design, or creative
  3. Propose a podcast topic or video series by emailing opendevsociety@cc.cc
  4. Share your portfolio or previous work when proposing ideas
  5. Collaborate with our media team via Discord or GitHub Discussions

Media Contribution Ideas:

  • Record a podcast episode interviewing a contributor or discussing an open-source topic
  • Create a 5-minute tutorial video for one of our tools
  • Design social media graphics for project announcements
  • Create an animated explainer video about Open Dev Society
  • Design swag (stickers, t-shirts) for community members

Media Guidelines:

  • Ensure content aligns with our mission and values
  • Follow our Brand Guidelines
  • All content should be licensed under Creative Commons (CC BY-SA 4.0) or similar open license
  • Prioritize accessibility (captions for videos, alt text for images)

πŸŽ‰ Events & Community

Who this is for: Event organizers, community managers, facilitators, coordinators

What you can do:

  • Organize hackathons, meetups, or conferences
  • Facilitate community discussions or workshops
  • Moderate Discord, forums, or social media channels
  • Plan virtual or in-person events
  • Coordinate speaker lineups or event logistics
  • Build partnerships with other communities or organizations

How to get started:

  1. Join our community channels (Discord, LinkedIn, GitHub Discussions)
  2. Check our Roadmap for upcoming events
  3. Propose an event idea by opening an issue with the label event proposal
  4. Volunteer to help with existing events (check issues labeled events or community)
  5. Reach out to our community team at opendevsociety@cc.cc

Event Contribution Ideas:

  • Organize a virtual hackathon for beginners
  • Host a monthly contributor meetup
  • Coordinate a workshop series on specific topics
  • Plan an annual Open Dev Society conference
  • Facilitate a Q&A session with project maintainers

Event Planning Resources:


🌍 Translation & Localization

Who this is for: Translators, multilingual contributors, localization experts

What you can do:

  • Translate documentation, websites, or project content into other languages
  • Review and improve existing translations
  • Help localize UI elements or error messages
  • Adapt content for cultural relevance

How to get started:

  1. Check for issues labeled translation or localization
  2. Propose a new language by opening an issue
  3. Follow our Translation Guidelines
  4. Submit translations via pull request or designated translation platform

Currently supported languages:

  • English (primary)
  • [Add others as you expand]

Languages we'd love to support:

  • Spanish, French, German, Hindi, Chinese, Arabic, Portuguese, and more!

πŸ› Bug Reports & Feature Requests

Who this is for: Anyone using our projects!

What you can do:

  • Report bugs you encounter
  • Suggest new features or improvements
  • Provide feedback on usability or user experience
  • Test new releases and report issues

How to report a bug:

  1. Check if the bug has already been reported in Issues
  2. If not, open a new issue with the label bug
  3. Provide:
    • Clear description of the bug
    • Steps to reproduce
    • Expected vs. actual behavior
    • Screenshots or error messages (if applicable)
    • Environment details (OS, browser, version, etc.)

How to request a feature:

  1. Check if the feature has already been requested in Issues
  2. If not, open a new issue with the label feature request
  3. Provide:
    • Clear description of the feature
    • Why it would be useful (use case)
    • Any ideas for implementation (optional)

Getting Started

Step 1: Explore Our Projects

Visit our GitHub Organization to see all our projects:

  • OpenStock - Stock market tracking platform
  • OpenReadme - GitHub profile README generator
  • BookTrace - Book discovery platform
  • And more coming soon!

Step 2: Join Our Community

Connect with other contributors:

Step 3: Find a Task

Look for issues labeled:

  • good first issue - Perfect for newcomers
  • help wanted - We need your expertise!
  • documentation - Content and writing tasks
  • education - Teaching and learning initiatives
  • events - Community events and organization
  • design - Creative and media contributions

Step 4: Let Us Know You're Interested

Comment on the issue or reach out via email/Discord to express interest and ask questions.

Step 5: Make Your Contribution

Follow the specific guidelines for your contribution type (code, content, education, etc.).

Step 6: Submit Your Work

  • Code & Documentation: Submit a pull request
  • Events & Workshops: Coordinate with community team
  • Media & Creative: Share via designated channels or email

Step 7: Get Recognized!

We celebrate all contributions and recognize contributors publicly (with your permission).


Our Values

When contributing to Open Dev Society, please keep these values in mind:

βœ… Open & Transparent: We build in the open and welcome feedback
βœ… Inclusive & Welcoming: Everyone belongs here, regardless of experience level
βœ… Free & Accessible: We never lock knowledge or tools behind paywalls
βœ… Community-Driven: We listen to and prioritize our community
βœ… Quality & Impact: We aim for meaningful contributions that make a difference
βœ… Respectful & Collaborative: We treat each other with kindness and respect


Code of Conduct

All contributors must follow our Code of Conduct. In summary:

  • Be respectful and welcoming
  • Harassment, discrimination, or inappropriate behavior will not be tolerated
  • Report violations to opendevsociety@cc.cc

By contributing, you agree to uphold these standards and help maintain a positive, inclusive community.


Recognition

We believe in celebrating contributions! Here's how we recognize contributors:

  • Contributors List: All contributors are credited in project READMEs
  • Social Media Shoutouts: We highlight contributions on LinkedIn, Twitter, and Instagram
  • Contributor Badges: Special recognition for ongoing contributors
  • Annual Report: Yearly summary celebrating community contributions
  • Swag & Merch: Top contributors receive Open Dev Society swag (when available)

Documentation Style Guide

  • Use clear, concise language
  • Write in second person ("you") when addressing readers
  • Use active voice
  • Break up text with headers, lists, and visuals
  • Include code examples with proper syntax highlighting
  • Add alt text to all images

Code Style Guidelines

Each project may have specific coding standards. Check the project's CONTRIBUTING.md for details.

General guidelines:

  • Write clean, readable code
  • Follow existing code patterns in the project
  • Add comments for complex logic
  • Include tests for new features
  • Update documentation for code changes

Questions?

We're here to help!


Thank You! πŸ™

Open Dev Society exists because of contributors like you. Whether you're fixing a typo, leading a workshop, designing graphics, or building new featuresβ€”every contribution matters.

Thank you for being part of this community. Let's build the future together, openly.


Additional Resources


Open Dev Society β€” Building the future, openly.

Because when knowledge is free, innovation is limitless.

About

ByteMyCV is an open-source, AI-powered resume analysis tool that provides structured insights, skill extraction, ATS scoring, and content evaluation. Built under Open Dev Society (ODS) to enable transparent, community-driven development.

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published