Contributing to CloudCore Networks Educational Platform

We are thrilled that you are interested in contributing to the CloudCore Networks Educational Platform! This document provides guidelines for contributions to this project. We want to create a welcoming environment for everyone interested in contributing, so we ask that you follow these guidelines to ensure a smooth collaboration process.

Code of Conduct

By participating in this project, you agree to uphold the standards of our Code of Conduct. Please take a moment to read CODE_OF_CONDUCT.md to understand what behaviors will and will not be tolerated.

How to Contribute

Contributing to this platform can be in various forms, such as submitting bug reports, suggesting enhancements, and creating pull requests with updates or new features.

Reporting Bugs

Before submitting a bug report, please check the issue tracker to see if it has already been reported. If it is new, open a new issue with the following:

  • Descriptive title - Use a clear and descriptive title to identify the problem.
  • Detailed description - Provide a more detailed explanation of the issue.
  • Reproduction steps - List the steps to reproduce the behaviour.
  • Expected behaviour - Describe what you expected to happen.
  • Actual behaviour - Describe what actually happened. Include screenshots if possible.
  • Environment details - Add information like the browser version, Quarto version, and OS.

Suggesting Enhancements

Enhancement suggestions are also welcome. Please open an issue and provide:

  • Descriptive title - Use a clear and descriptive title for the enhancement suggestion.
  • Detailed description - Provide a detailed explanation of the suggested enhancement.
  • Possible implementation - Discuss a possible approach to implement the enhancement, if applicable.
  • Additional context - Add any other context or screen shots about the feature request.

Pull Requests

We love direct contributions to the codebase! Here’s a quick guide on how to make a clean pull request:

  1. Fork the repository - Start by forking the repository on GitHub.
  2. Create a branch - Create a branch in your fork for your contributions.
  3. Make your changes - Add your changes to this branch, adhering to the coding standards and documentation style of the project.
  4. Write descriptive commit messages - Use clear and descriptive messages for your commits.
  5. Test your changes - Ensure your changes do not break any existing functionality and add any relevant tests if introducing new features.
  6. Submit a pull request - Push your changes to your fork and then submit a pull request to the main repository. Provide a clear and contextually rich description of what your pull request does.

Setting Up Your Environment

Here’s a quick primer on setting up your development environment to contribute to this project:

git clone https://github.com/teaching-repositories/cloudcore.git
cd cloudcore
# install dependencies, setup environment, etc.

Questions or Additional Help

If you need more information or assistance, feel free to reach out through our community forums or directly on the project’s issues page.

Thank you for contributing to CloudCore Networks’ Educational Platform! We look forward to your contributions and are excited to see what you bring to this educational initiative.