Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

78 lines (55 loc) · 2.44 KB

Contributing to Artichoke – clang-format Runner

👋 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.

The Artichoke clang-format runner is used to lint C sources in development and CI.

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 the Artichoke clang-format runner in this repository.

If you would like to contribute code to the Artichoke clang-format runner 👩‍💻👨‍💻, 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

The Artichoke clang-format runner includes JavaScript and Text sources. Developing on the runner requires configuring several dependencies.

Node.js

The Artichoke clang-format runner is implemented in Node.js, which is required for running it.

Node.js is an optional dependency that is used for formatting text sources with prettier.

Node.js is only required for formatting if modifying the following filetypes:

  • md
  • yaml
  • yml

You will need to install Node.js.

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

brew install node

Linting

npm run fmt

Updating Dependencies

Regular dependency bumps are handled by @dependabot.