ml-opensource / ml-opensource/Playbook

Contributing guide

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

Nobody has claimed this yet.

enhancement
Dominant language
No language data
Stars
16
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Things that could/should be in there:

  • Reporting Issues / Making PRs
  • Git Flow
  • Reviews
  • README, CHANGELOG update
  • Dependency Managers - Carthage (archive..) / CocoaPods/ SPM
  • Tags, Releases
  • More?

Contributor guide

No contributing guide indexed for this repository

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

Review the repository's README and CHANGELOG, then identify where a contributing guide should live. Use the checklist as the required scope: issue and pull request workflow, Git Flow, reviews, release documentation, and Carthage, CocoaPods, and SPM guidance. Done means the guide covers these topics in a coherent, maintainable form.

Written by the indexing model from the issue text.

Assessment

Tech stack
ios
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.