mirror of https://github.com/BillyOutlast/oboromi.git synced 2026-07-01 19:54:43 -04:00

Files

T

Nikilite 67864b0de6 changed license to GPLv3

Update license from MPL-2.0 to GPL-3.0

Update license agreement to GPL v3

Update README.md

2025-11-21 23:42:21 +01:00

1.9 KiB

Raw Permalink Blame History

Contributing to oboromi

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to oboromi. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Getting Started

Prerequisites

To build and run oboromi, you will need:

Rust: Latest stable version. Install Rust.
CMake: Version 3.16 or higher.
Ninja: Build system.
C++ Compiler: MSVC (Windows) or Clang (macOS/Linux).

Building the Project

Clone the repository:

git clone https://github.com/0xNikilite/oboromi
cd oboromi

Build and run:
```
cargo run
```

Running Tests (no tests yet)

We prioritize correctness. Please ensure all tests pass before submitting a PR.

cargo test

Code Style

We follow standard Rust community guidelines.

Formatting: Run cargo fmt to ensure your code is formatted correctly.
Linting: Run cargo clippy to catch common mistakes and improve code quality. (rn it's normal if it fails)

Submitting a Pull Request

Fork the repository and create your branch from main.
If you've added code that should be tested, add tests.
Ensure the test suite passes.
Make sure your code lints.
Issue that pull request!

Reporting Bugs

Bugs are tracked as GitHub issues. When filing an issue, please explain the problem and include additional details to help maintainers reproduce the problem:

Use a clear and descriptive title for the issue to identify the problem.
Describe the exact steps which reproduce the problem.
Describe the behavior you observed after following the steps.

License

By contributing, you agree that your contributions will be licensed under its GNU General Public License v3.

1.9 KiB Raw Permalink Blame History