plone / plone/meta

Linter: rstcheck

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

Nobody has claimed this yet.

04 type: enhancement 14 prio: low 41 lvl: easy
Dominant language
Python
Stars
6
Forks
7
Avg merge
2d 19h
Merged PRs (30d)
5

Description

https://pypi.org/project/rstcheck/

I see that plone.rest is starting to use it.

Contributor guide

Open the contributing guide

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

Read the rstcheck project documentation and inspect how plone.rest is beginning to use it. Determine what configuration this repository should standardize for the linter and verify that the resulting setup covers the intended reStructuredText checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.