pendulum-chain / pendulum-chain/pendulum

Add 'taplo' to the CI workflow to check the formatting of Cargo.toml files

Open
#497 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
45
Forks
13
Avg merge
5d 15h
Merged PRs (30d)
4

Description

Context

There is a tool called taplo that can check and format TOML files. Since different IDEs by default have different rules for formatting TOML files, we want to streamline the formatting by using this tool.

TODO

There is no precommit hook for the pendulum repository yet and it's probably good enough to check for the formatting in the CI and leave it to the developers to run taplo fmt locally before creating the PR.

  • Add taplo to the automated build checks in the Github CI workflow. Only check for wrong formatting with taplo fmt --check but don't correct the formatting in the CI
  • Add a configuration file. We can put it into .config/taplo.toml and draw inspiration from the one used for the polkadot-sdk here
  • Add instructions to install and use taplo to the README.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the GitHub CI workflow and reviewing the polkadot-sdk .config/taplo.toml configuration linked in the issue. Add .config/taplo.toml, configure the workflow to run taplo fmt --check, and document taplo installation and use in the README. Done means CI checks Cargo.toml formatting without changing files and the README explains the local command.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, rust
Domain
build-system, ci-cd, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.