Skip to content

OPEN_SOURCE.md

Latest commit

 

History

History
121 lines (79 loc) · 5.89 KB

OPEN_SOURCE.md

File metadata and controls

121 lines (79 loc) · 5.89 KB
Raw

Open Source at Code Savanna 🌍

Welcome to Code Savanna's Open Source Community! We are thrilled to have you here and excited about the positive impact we can make together. Code Savanna is committed to empowering the next generation of leaders through open access to technology, innovation, and entrepreneurship. By sharing our projects with the world, we aim to drive digital inclusion and promote socioeconomic progress in underrepresented communities.

Whether you’re a seasoned developer, a student, or just starting out in open source, your contributions help us create a meaningful and sustainable impact. Here's everything you need to know about contributing to our open-source projects.

Why Contribute to Code Savanna?

Code Savanna believes in the power of open collaboration. By contributing to our projects, you’re helping to:

  • Build Software that Empower Communities in Africa and Beyound by building innovative tools and resources that are accessible to everyone.
  • Gain valuable experience in open-source software development while working with a diverse, global community of developers and innovators.
  • Advance your skills in computing, coding, and project management through hands-on contributions to real-world projects.
  • Foster change by helping bridge the digital divide and contribute to the socioeconomic development of marginalized communities.

Our Core Open Source Projects

Here are some of our flagship open-source projects where you can contribute:

1. Code Analyzer Tool

A tool for efficiently identifying bugs and improving code quality in large-scale projects. Our open-source community is working on integrating machine learning models into the tool to make it even more powerful. Whether you’re into ML, bug tracking, or code optimization, there’s something here for you.

2. Community Projects & Local Innovation

At Code Savanna, we have numerous community-focused projects that provide solutions to local challenges through technology. Get involved with projects that focus on sustainability, health, education, and more.

How to Get Involved

1. Find a Project

Browse through our repositories on GitHub and find a project that excites you! Check out the issues page on each project to see what areas need help. You can also join our discussions to ask questions or share ideas.

2. Fork and Clone the Repository

After choosing a project:

  1. Fork the repository to your own GitHub account.
  2. Clone the forked repository to your local machine using: 
    git clone https://github.com/YourUsername/RepositoryName.git

3. Make Your Changes

Once you've set up the project locally, you're ready to contribute:

  • Pick an open issue or create one if you find a bug or have an idea for an improvement.
  • Follow the contribution guidelines for each project (usually found in the CONTRIBUTING.md file) to ensure your changes meet the project's coding standards.
  • Test your code to ensure it works correctly and doesn’t break existing functionality.

4. Create a Pull Request (PR)

Once your changes are ready:

  • Push your changes to your fork.
  • Open a pull request (PR) on the original repository.
  • In your PR, provide a detailed description of your changes, explain why they are necessary, and link any related issues.

Code of Conduct

We aim to create an inclusive and welcoming community where contributors from all backgrounds feel comfortable collaborating. To that end, we enforce a Code of Conduct across all our projects.

Please:

  • Be respectful of all contributors.
  • Provide constructive feedback.
  • Collaborate in a manner that fosters growth and learning.

You can read the full Code of Conduct to understand our community standards.

Contribution Guidelines

Best Practices for Contributions:

  • Write clear, descriptive commit messages to explain the intent behind your changes.
  • Follow the coding standards outlined in each repository (e.g., for Python projects, follow PEP 8).
  • Include unit tests for any new functionality to ensure that your code is robust and doesn’t introduce bugs.
  • Keep your pull requests focused on one issue or feature at a time. Small, well-defined changes are easier to review and integrate.

For a more detailed guide on how to contribute, refer to our Contribution Guidelines.

Getting Help

We are here to support you! If you have questions or need guidance, you can:

  • Ask a question by opening a GitHub Discussion in the relevant repository.
  • Reach out to project maintainers via the README.md or CONTRIBUTING.md file in the specific repository.
  • Join our community by participating in meetups, hackathons, and collaborative projects.

Recognition for Contributors

We value all contributions! You can gain recognition in several ways:

  • Have your name listed in the Contributors section of each project.
  • Earn badges and acknowledgments for significant contributions to our major projects.
  • Gain access to networking opportunities and professional development resources through Code Savanna’s community.

We also nominate outstanding contributors for featured profiles in our newsletters and blog posts.

Thank You for Being Part of Code Savanna!

By contributing to Code Savanna’s open-source initiatives, you are joining a community of changemakers dedicated to building a more inclusive and innovative future. Your work is helping to empower communities and give young people the tools they need to succeed.

Let’s build a better tomorrow, one commit at a time!

Useful Links: