CONTRIBUTING.md

Contributing to Artichoke – artichoke.github.io

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

Artichoke aspires to be a recent MRI Ruby-compatible implementation of the Ruby programming language. There is lots to do.

artichoke.github.io is used to for web infrastructure and redirects of GitHub-provided URLs.

If 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. File bugs specific to artichoke.github.io in this repository.

If you would like to contribute code to rand_mt 👩‍💻👨‍💻, 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. Good first issues are labeled E-easy.

Discussion

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

Setup

artichoke.github.io is a static site that includes Ruby, HTML, and JavaScript sources. Developing artichoke.github.io requires configuring several dependencies.

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

Building

Building the static site can be done with an npm run-task:

npm run build

Linting and formatting are available as npm run scripts:

npm run fmt
npm run lint
npm run lint:fix

Updating Dependencies

Regular dependency bumps are handled by @dependabot.