Skip to content

Latest commit

 

History

History
68 lines (40 loc) · 3.86 KB

CONTRIBUTING.md

File metadata and controls

68 lines (40 loc) · 3.86 KB
Raw

Contributing to Xray

This project is still in the very early days, and isn't going to be usable for even basic editing for some time. At this point, we're looking for contributors that are willing to roll up their sleeves and solve problems. Please communicate with us however it makes sense, but in general opening a pull request that fixes an issue is going to be far more valuable than just reporting an issue.

As the architecture stabilizes and the surface area of the project expands, there will be increasing opportunities to help out. To get some ideas for specific projects that could help in the short term, check out issues that are labeled "help wanted". If you have an idea you'd like to pursue outside of these, that's awesome, but you may want to discuss it with us in an issue first to ensure it fits before spending too much time on it.

It's really important to us to have a smooth on-ramp for contributors, and one great way you can contribute is by helping us improve this guide. If your experience is bumpy, can you open a pull request that makes it smoother for the next person?

Communicating with maintainers

The best way to communicate with maintainers is by posting a issue to this repository. The more thought you put into articulating your question or idea, the more value you'll be adding to the community and the easier it will be for maintainers to respond. That said, just try your best. If you have something you want to say, we'd prefer that you say it imperfectly rather than not saying it at all.

You can also communicate with maintainers or other community members on the #xray channel on Atom's public slack instance. After you request an invite via this form, you can access our Slack instance at https://atomio.slack.com.

Building

So far, we have only built this project on macOS. If you'd like to help us improve our build or documentation to support other platforms, that would be a huge help!

Install system dependencies

Install Node v8.9.3

To install Node, you can install nvm and then run nvm install v8.9.3.

Later versions may work, but you should ideally run the build with the same version of Node that is bundled into Xray's current Electron dependency. If in doubt, you can check the version of the electron dependency in xray_electron/package.json, then run process.versions.node in the console of that version of Electron to ensure that these instructions haven't gotten out of date.

Install Rust

You can install Rust via rustup. We currently require building on the nightly channel in order to use wasm_bindgen for browser support.

Install Yarn

Follow the installation instructions on the Yarn site.

Run the build script

This repository contains several components in top-level folders prefixed with xray_*. To build all of the components, simply run this in the root of the repository:

script/build

To build a release version (which will be much faster):

script/build --release

Running

We currently only support launching the application via the CLI. For this to work, you need to set the XRAY_SRC_PATH environment variable to the location of your repository. The CLI also currently requires an argument:

XRAY_SRC_PATH=. script/xray .

That assumes you built with --release. To run the debug version, use xray_debug instead:

XRAY_SRC_PATH=. script/xray_debug .

Running tests and benchmarks

  • All tests: script/test
  • Rust tests: cargo test in the root of the repository or a Rust subfolder.
  • Front-end tests: cd xray_ui && yarn test
  • Benchmarks: cargo bench