matrix-org / matrix-org/sytest

CONTRIBUTING.rst is incorrect

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

Nobody has claimed this yet.

Dominant language
Perl
Stars
81
Forks
63
Avg merge
1h 47m
Merged PRs (30d)
1

Description

It claims that sytest is the same as synapse, but sytest doesn't require newsfiles, for example

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

Open CONTRIBUTING.rst and review the statement that sytest is the same as synapse, including the newsfiles example. Correct the inaccurate wording so the contribution instructions distinguish sytest from synapse, then verify the surrounding guidance remains consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.