Skip to content

Latest commit

 

History

History
84 lines (59 loc) · 3.28 KB

CONTRIBUTING.md

File metadata and controls

84 lines (59 loc) · 3.28 KB

Contributing to Onyx

Thank you for wanting to contribute to Onyx!

Please read Onyx's Code of Conduct before contributing, as all contributing members are expected to adhere to it.

Bug Reports

If you found a bug in Onyx, first ensure there is not already a similar bug open on Onyx's GitHub issue tracker. If there is not, feel free to open one.

A bug could be anything from a compiler crash, to the wrong output from a core library function. If you are unsure if what you found is a bug, open an issue anyway and we'll discuss from there.

Code Changes

Contributing code changes to Onyx is welcome by following the process outlined below.

  1. Find or open a GitHub issue relevant to the change you are wanting to make and comment saying you wish to work on this issue. This just helps me know what is getting done so I know I don't have to worry about something. If your change would include new functionality, this issue will serve as a place to discuss the details of what you are adding, to ensure everyone is in agreement on how the new functionality will work.
  2. Create a fork and work on your code change. Commit frequently in small commits. When making commits, be descriptive in your message.
  3. When ready, open a GitHub pull request to merge your changes with the master branch. Once approved, your changes will be tested to ensure they pass CI/CD.
  4. I will review the committed request. I reserve the right to provide feedback, request modifications or deny any requests, with or without an explanation. There may be multiple rounds of feedback.
  5. Once everything is approved, your code will be merged/rebased into the master branch.

Code Standard

When contributing code, it is important that your code meets Onyx's code standard. While not extensive, it does ensure the codebase stays relatively uniform.

  1. Use 4 spaces per indentation level.
  2. Use descriptive identifier names. No one should have to guess what the variable/function is for.
  3. Separate a large block of code into small blocks by placing blank lines between distinct parts of the code.
  4. The C components of Onyx are intentionally divided into only a handful of files. You will likely not need to create a new .c or .h file in repository.

Development Environment

Since Onyx is developed in C, the barrier to entry is quite low. You simply need a C compiler (gcc, clang and MSCV are known to work).

The only external dependency you may need is Wasmer installed and accessible by your user. Simply run wasmer to ensure it is working. Note, this is not needed if you are on Windows, or compiling using the ovmwasm runtime.

To compile on Linux and MacOS, you need to source the settings.sh file first. This sets environment variables that are used by the build script.

source ./settings.sh

Now you should be ready to compile the code. Simply run the following on Linux/MacOS.

./build.sh compile install

Or the following on Windows.

build.bat

This will compile the code, place the new version in the dist folder, and then copy the dist folder to your ONYX_PATH.