Skip to content

Latest commit

 

History

History
102 lines (71 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

102 lines (71 loc) · 3.57 KB
Raw

Contributing to ByteOS

Thank you for considering contributing to ByteOS! Your help is greatly appreciated. This document provides guidelines for contributing to the project.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Development Setup
  4. Style Guides
  5. Additional Resources

Code of Conduct

This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to me :).

How Can I Contribute?

Reporting Bugs

If you find a bug in the project, please check the existing issues first. If the bug hasn't been reported yet, open a new issue and include as much detail as possible:

  • Steps to reproduce the bug
  • Expected and actual behavior
  • Screenshots, logs, or other supporting information

Suggesting Enhancements

If you have ideas for new features or improvements, please check the existing issues and the project roadmap. If your idea hasn't been suggested yet, open a new issue and describe your suggestion in detail:

  • What problem does the enhancement solve?
  • How would you like to see it implemented?

Submitting Pull Requests

To contribute code to ByteOS, follow these steps:

  1. Fork the repository and clone your fork.
  2. Create a new branch for your feature or bugfix: git checkout -b feature/your-feature-name or git checkout -b bugfix/your-bugfix-name
  3. Make your changes, ensuring they adhere to the project's coding standards.
  4. Commit your changes with a descriptive commit message.
  5. Push your changes to your forked repository.
  6. Open a pull request from your branch to the main branch of the original repository.

Please ensure your pull request includes:

  • A clear description of the changes
  • References to any related issues
  • Tests for your changes, if applicable

Development Setup

To set up your development environment for ByteOS, follow these instructions:

  1. Clone the repository:

    git clone https://github.com/iyksh/ByteOS.git
cd ByteOS

  2. Install dependencies: Ensure you have the necessary tools installed (e.g., GCC, NASM, LD, QEMU).

  3. Build the project: Use the provided Makefile to compile the project.

    chmod +x ./build.sh
./build.sh

  4. Run the project: Execute the compiled code using QEMU.

     qemu-system-i386 -kernel $HOME/sysroot/boot/myos.kernel

Style Guides

Commit Messages

  • Use the imperative mood in the subject line (e.g., "Add feature" not "Added feature").
  • Limit the subject line to 50 characters.
  • Include a detailed description of the change.

Code Style

  • Follow the project's existing coding style.
  • Ensure your code is well-documented.
  • Use meaningful variable and function names.

Additional Resources

  • OSDev Wiki: A comprehensive resource for operating system development.
  • Project README: Overview and objectives of the project.
  • Existing Issues: Current issues and enhancements under consideration.