Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

53 lines (38 loc) · 2.52 KB

Contributing to InfinityOS

Thank you for your interest in contributing to InfinityOS! We welcome contributions from the community to help improve and evolve the project. This document will guide you through the process of contributing to the project.

Table of Contents

Code of Conduct

By participating in this project, you agree to follow the Code of Conduct. Please read it to ensure a welcoming and respectful environment for everyone.

How to Contribute

Reporting Bugs

If you find a bug, please report it using the following steps:

  1. Check the existing issues to see if the bug has already been reported.
  2. If the issue is not listed, create a new issue with a detailed description of the bug, including:
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • Any relevant logs or error messages

Suggesting Enhancements

We welcome suggestions for new features or improvements! To suggest an enhancement:

  1. Check the existing issues to ensure it hasn't already been suggested.
  2. If it hasn't, create a new issue with a clear and concise description of the enhancement, including any relevant context or use cases.

Contributing Code

We appreciate code contributions! To contribute code:

  1. Fork the repository and create a new branch for your feature or fix.
  2. Ensure that your code adheres to the coding guidelines.
  3. Write tests for your changes if applicable.
  4. Run the tests to make sure everything works as expected.
  5. Submit a pull request with a clear description of the changes, referencing the related issue (if applicable).

Coding Guidelines

  • Rust conventions: Follow Rust's official style guide and conventions.
  • Documentation: Write clear and concise documentation for your code. Use doc comments (//) where appropriate.
  • Testing: Ensure your code is well-tested. Write unit tests, integration tests, and any necessary test cases for new features or bug fixes.

License

By contributing to InfinityOS, you agree that your contributions will be licensed under the AGPL v3.0 License.