Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

59 lines (39 loc) · 1.7 KB

Contributing to Artichoke

👋 Hi and welcome to Artichoke. Thanks for taking the time to contribute! 💪💎🙌

www.artichokeruby.org is the project website for Artichoke Ruby. There is lots to do.

If the Artichoke does not run Ruby source code in the same way that MRI does, it is a bug and we would appreciate if you filed an issue so we can fix it.

If you would like to contribute code 👩‍💻👨‍💻, find an issue that looks interesting and leave a comment that you're beginning to investigate. If there is no issue, please file one before beginning to work on a PR.

Discussion

If you'd like to engage in a discussion outside of GitHub, you can join Artichoke's public Discord server.

Setup

The Artichoke project website is a static site that includes HTML and JavaScript sources. Developing the site requires a Node.js toolchain.

Node.js

The project website uses Node.js for linting, orchestration, and development tooling.

You will need to install Node.js.

On macOS, you can install Node.js with Homebrew:

brew install node

Node.js Packages

Once you have Node.js installed, you can install the packages specified in package.json by running:

npm install