layer5 icon indicating copy to clipboard operation
layer5 copied to clipboard

[PR] Add a section to file on how to open new PR for newcomers

Open kamalbuilds opened this issue 3 years ago • 12 comments

Current Behavior

As dicussed in the previous meet, many newcomers face the issue of getting started . So this will help them in getting started. Desired Situation

1> A small section needs to be added on how to open your first PR.


[Optional] Alternatives

[Optional] Additional context

file -> https://layer5.io/community/handbook/contribution

Contributor Resources

The layer5.io website uses Gatsby, React, and GitHub Pages. Site content is found under the master branch.

kamalbuilds avatar Sep 10 '22 14:09 kamalbuilds

Hii @legendarykamal I will love to work on this but before that I want to know what exactly need to be done! What changes this issue really need? I got that it needs some changes to the contribution page but what changes it need! And if you have any mock or where you want to add then that will be helpful to solve this issue.

sam1code avatar Sep 10 '22 16:09 sam1code

Hi @sam1code , apparently many docs related to contributions are present at many places. Few at website, few at docs, few at here in Github readme files. So the idea is to make a section which consolidates almost everything at one place if possible so that whenever a newcomer joins it should be an easy ride for them towards their first contribution. All the resources needed to do execute this has already been provided by Kamal in the issue

75asu avatar Sep 10 '22 18:09 75asu

Ooh got it thankyou!

sam1code avatar Sep 10 '22 18:09 sam1code

I love to work on this. @legendarykamal

sam1code avatar Sep 11 '22 00:09 sam1code

yes @sam1code you may go ahead :arrow_forward:

kamalbuilds avatar Sep 11 '22 02:09 kamalbuilds

Hi @sam1code , apparently many docs related to contributions are present at many places. Few at website, few at docs, few at here in Github readme files. So the idea is to make a section which consolidates almost everything at one place if possible so that whenever a newcomer joins it should be an easy ride for them towards their first contribution. All the resources needed to do execute this has already been provided by Kamal in the issue

Thankyou @measutosh for the sleek reply :) although much of the things about projects are provided in repo overview section. This will be a :heavy_plus_sign: to it.

kamalbuilds avatar Sep 11 '22 03:09 kamalbuilds

The handbook isn’t just about the layer5.io project and shouldn’t necessarily point to the contributing.md on this repo. Please think though this concern a little more.

leecalcote avatar Sep 13 '22 13:09 leecalcote

Yes , agreed Lee, The idea was to open just a normal section on how to open a new PR for the first time contributors.

On Tue, Sep 13, 2022, 6:41 PM Lee Calcote @.***> wrote:

The handbook isn’t just about the layer5.io project and shouldn’t necessarily point to the contributing.md on this repo. Please think though this concern a little more.

— Reply to this email directly, view it on GitHub https://github.com/layer5io/layer5/issues/3165#issuecomment-1245393834, or unsubscribe https://github.com/notifications/unsubscribe-auth/AW33QNCKOWQOKCBRPTI2NVDV6B4RHANCNFSM6AAAAAAQJLWWOM . You are receiving this because you were mentioned.Message ID: @.***>

kamalbuilds avatar Sep 13 '22 13:09 kamalbuilds

So @legendarykamal, Should I give the link or not?

sam1code avatar Sep 13 '22 16:09 sam1code

No not needed, just the section would be enough.

kamalbuilds avatar Sep 13 '22 17:09 kamalbuilds

@legendarykamal can you pls assign me this issue so I can do my first PR at layer5

nik132-eng avatar Sep 17 '22 08:09 nik132-eng

sure @nik132-eng here you go :rocket:

kamalbuilds avatar Sep 17 '22 08:09 kamalbuilds