[GOOD FIRST ISSUE]: Documentation Cleanup - Addition of Contribution.md

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

@Logic769 is already working on this.

Since Oct 28, 2026.

  • #71 by @Logic769 — open

Assessment

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

Research direction

Start with README.md and separate the contributor setup and workflow information into a new CONTRIBUTING.md. Use the linked contribution guides as references, and check the open pull request #71 for the work already under way. Done means the contributor information has a dedicated guide and the README points readers to it; the optional Discord and website links depend on maintainer approval.

Written by the indexing model from the issue text.

Description

good first issue
Context
Problem Statement:
  • The current README.md contains both general project information and detailed contributor setup instructions, including prerequisites, installation, running the project locally, and the contribution workflow.

  • As the project grows, keeping all of this information in the README can make it harder for users to find the information they need and harder for contributors to follow a dedicated setup guide.

Zplit Right Now:
Image Image

What Zplit would look After Cleanup(Refrence from PictoPy):

Image
Proposed Fix:

Create a dedicated CONTRIBUTING.md file containing the information required for developers who want to contribute to Zplit.

Optional:(Only done if the maintainer approves of this)
  • (I can also add discord links and code of conduct if you guys have it)
  • (The link for the zplit website also be a great addition if you guys have it running.)
What Needs to Be Done
Tasks:
  1. Addition of contributing.md.
  2. Addition of Discord Links.
  3. Additon of website links.
Resources
Getting Started
  • I have joined the Discord server and will post updates there
  • I have read the Contribution Guide
  • I understand this issue is assigned on a first-come, first-served basis
Dominant language
Dart
Stars
20
Forks
39
Avg merge
3d 12h
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 StabilityNexus/Zplit

All issues in StabilityNexus/Zplit

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.