[GOOD FIRST ISSUE]: Documentation Cleanup - Addition of Contribution.md
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
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:
What Zplit would look After Cleanup(Refrence from PictoPy):
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:
- Addition of contributing.md.
- Addition of Discord Links.
- 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
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from StabilityNexus/Zplit
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
StabilityNexus/Zplit#77 · 1 comment ·
-
[GOOD FIRST ISSUE] [MINOR BUG]: Website uses default starter favicon instead of official Zplit logoPossibly taken A pull request linked to this issue is open or already merged. Opengood first issue
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
StabilityNexus/Zplit#73 ·
-
[FEATURE]: Enhancement of Onboarding Screen and Low Res AssetsPossibly taken A pull request linked to this issue is open or already merged. Openenhancement
Difficulty 3/5 1-2 days Newbie friendliness 61/100
StabilityNexus/Zplit#75 · 2 comments ·
-
gsoc
Difficulty 4/5 3-5 days Newbie friendliness 48/100
StabilityNexus/Zplit#56 ·
-
gsoc
Difficulty 5/5 Over a week Newbie friendliness 35/100
StabilityNexus/Zplit#52 ·
All issues in StabilityNexus/Zplit
Similar issues
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
🚀 [firebase_core] Bump Firebase C++ SDK (14.1.0 → 14.2.0)Possibly taken @SelaseKay claimed this today. OpenNeeds Attention type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
firebase/flutterfire#18977 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
agent: is checked on a wrapper holding several checkables answers from the first one in tree orderOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
AlphaWaveSystems/flutter-probe#865 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
ubuntu/app-center#2306 ·
Maintainers usually reply within 1 day