Documentation polish is fine. The argument is about posting doc typo issue
by official

Sheng Wu 吴晟
Twitter, wusheng1108


Anita Ihuman <an...@api7.ai> 于2022年4月8日周五 20:16写道:

> Often times, contributors focus on improving documentation or project
> UI(minor fixes) before digging into the core parts of the project.
> Personally I consider those kind of issues as beginner friendly
>
> On Fri, Apr 8, 2022 at 1:06 PM Sheng Wu <wu.sheng.841...@gmail.com> wrote:
>
> > >  Documentation typo fix.
> >
> > This is really not a good thing as an official quick start or first
> issue.
> >
> > I am not sure whether you noticed an argument list on Twitter,
> > https://twitter.com/Manjusaka_Lee/status/1511267848735191042
> > Twitter is nothing relative to ASF, but I want you to know the risk of
> > other ppl's disagreements.
> >
> > Sheng Wu 吴晟
> > Twitter, wusheng1108
> >
> >
> > Zhiyuan Ju <juzhiy...@apache.org> 于2022年4月8日周五 18:13写道:
> >
> > > Hi, folks,
> > >
> > > This question is benevolent and wise, and there is no uniform standard
> to
> > > measure. The reason for the question is that I found only a few good
> > first
> > > issues when I looked through all the subproject[1] issues of the Apache
> > > APISIX community.
> > >
> > >
> > > Last year, Ruofei Zhao helped to build the Good first issue page[2],
> and
> > > you will find that:
> > >
> > >
> > > 1. There have 11 issues with the Good first issue label in the
> > > apache/apisix repo,
> > >
> > > 2. There have four issues in the apache/apisix-dashboard repo
> > >
> > > 3. There have 0 or few good first issues in other repos.
> > >
> > >
> > > Maybe we don't have many good first issues currently, but I'd like to
> > know
> > > if we should have a clear scope for the Good first issues in Apache
> > APISIX
> > > projects? What's the good first issue that our community needs?
> > >
> > >
> > > Here's my proposal for different levels of contributors:
> > >
> > >
> > > 1. Newbie
> > >
> > > 1.1 Description: People who have never been exposed to programming and
> > have
> > > no knowledge of the project but wish to be involved in an open source
> > > project/community.
> > >
> > > 1.2 Cases: i18n, Documentation typo fix.
> > >
> > >
> > > 2. Beginner
> > >
> > > 2.1 Description: Programming experience (at any level of depth), but no
> > > background in the knowledge required for API gateways (technology:
> Nginx,
> > > OpenResty, etc.; knowledge: what is API gateway?)
> > >
> > > 2.2 Cases
> > >
> > > 2.2.1 Contribute independent features, i.e., issues that intersect less
> > > with the core. e.g. apache/apisix plugins.
> > >
> > > 2.2.2 Contributing test coverage, e.g., Dashboard, Ingress Controller
> > > project test writing.
> > >
> > > 2.2.3 Optimization of documentation, such as higher quality
> > > internationalized documentation.
> > >
> > >
> > > 3. Familiar
> > >
> > > 3.1 Description: Experience with production use of API gateways
> > (regardless
> > > of usage) and unfamiliarity with Apache APISIX code/products, but can
> get
> > > up to speed quickly.
> > >
> > > 3.2 Cases: Contribute valuable features and try to fix non-urgent bugs
> > > (giving each other some patience).
> > >
> > >
> > > 4. Advanced
> > >
> > > 4.1 Description: Active participants in the project know what they are
> > > doing and why.
> > >
> > > 5.2 Cases: No restrictions, but tends to lead to becoming a community
> > KOL,
> > > contributing more valuable features.
> > >
> > >
> > > After discussing and confirming the proposal, I hope we can pick out
> the
> > > practical issues for contributors based on the recommendation.
> > >
> > >
> > > Kindly share your opinion~
> > >
> > > [1] https://github.com/apache/?q=apisix-&type=all&language=&sort=
> > > [2] https://apisix.apache.org/contribute/
> > >
> > > Best Regards!
> > > @ Zhiyuan Ju <https://github.com/juzhiyuan>
> > >
> >
>

Reply via email to