[ENH] rst linter on circleCI

Open
#122 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Stale

Research direction

Start by reviewing the contribution guidelines referenced in #114 and the repository's CircleCI configuration. Identify how an RST linter can be run for the contribution documentation, and consider the work done when that check runs on CircleCI for RST files.

Written by the indexing model from the issue text.

Description

CI documentation enhancement

During refactoring the contribution guidelines in #114, we realized that it would be helpful to have a linter for rst files running on circleCI.

Dominant language
Python
Stars
3
Forks
2
Avg merge
3d 23h
Merged PRs (30d)
2

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from pyfar/gallery

All issues in pyfar/gallery

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.