Skip to content

Contribution Guidelines

Welcome to the OPEN-EDU Server project! We appreciate your interest in contributing to the development of the server. Before you start, please take a moment to review the following guidelines.

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior to [hyattherate2005@gmail.com].

How to Contribute

Reporting Bugs

If you encounter a bug or unexpected behavior, please follow these steps:

  1. Check Existing Issues: Check if the issue has already been reported by searching the GitHub Issues.

  2. Create a New Issue: If the issue is not found, create a new issue with a descriptive title and detailed description of the problem, including steps to reproduce it.

Requesting Features

If you have an idea for a new feature or enhancement, please follow these steps:

  1. Check Existing Requests: Check if the feature request already exists by searching the GitHub Issues.

  2. Create a New Request: If the feature request is not found, create a new issue with a clear title and detailed description of the proposed feature.

Creating Pull Requests

If you'd like to contribute code to the project, please follow these steps:

  1. Fork the Repository: Fork the repository to your GitHub account.

  2. Create a Branch: Create a new branch for your feature or bug fix.

  3. Make Changes: Implement your changes or additions to the codebase.

  4. Test Your Changes: Ensure that your changes do not introduce new issues and that existing functionality still works as expected.

  5. Create a Pull Request:Create a pull request from your branch to the main branch of the original repository. Provide a clear title and description for your changes.

Coding Standards

Please adhere to the coding standards and conventions used in the project. If unsure, refer to the Coding Standards document.

License

By contributing to the OPEN-EDU Server project, you agree that your contributions will be licensed under the MIT License.

Thank you for contributing! 🚀