ni / ni/nimi-python

CONTRIBUTING.md is out of date

Open
#1,267 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
Python
Stars
128
Forks
110
Avg merge
5d 14h
Merged PRs (30d)
10

Description

Changes to nimi-python have rendered some of the content of CONTRIBUTING.md obsolete. This is quite bad, it makes it very hard for newcomers to be onboarded.

For examples see section "Running System Tests"

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

Start by reading CONTRIBUTING.md, especially the “Running System Tests” section, and compare its instructions with the current nimi-python project setup. Update obsolete onboarding content so the documented process matches the repository’s current workflow and is usable by newcomers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.