feathr-ai/feathr

Proof-read the developer guide for new devs

Open

#164 opened on Apr 25, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Scala (244 forks)batch import
good first issue

Repository metrics

Stars
 (1,929 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

If you are a new developer and you just started developing things in Feathr, try to read our developer guide(https://github.com/linkedin/feathr/tree/main/docs/dev_guide).

If you found issues and things need to improve:

  • Raise an issue with us
  • Help us fix the issue.

It's a dev guide version of https://github.com/linkedin/feathr/issues/160.

Contributor guide

Research direction
Review the developer guide at https://github.com/linkedin/feathr/tree/main/docs/dev guide. Identify unclear sections, missing steps, or errors. Report findings as issues or submit pull requests with fixes. Focus on onboarding experience for new contributors.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80