Mentorship-android: Feature: commenting out the subheadings in pr and issue templates

Created on 24 Nov 2020  路  14Comments  路  Source: anitab-org/mentorship-android

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

The descriptions provided under the headings in PR and issue templates are not commented out.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Commenting out the descriptions in pull request and issue templates. i.e the part A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] could be in a comment tag so that it is only visible to the Author while creating a new issue / pr.

Additional context
Add any other context or screenshots about the feature request here.

Refer to the backend repository as they have implemented this.

DocumentatioTraining First Timers Only

Most helpful comment

The idea here is for the placeholder text that comes with issue/PR template, to come commented out. So the idea is for the markdown provided in the template to, instead of:

# heading

placeholder text

(...)

be like:

# heading

<!-- placeholder text -->

(...)

this will make the text not show up when rendered by GitHub in the comments.

cc @epicadk @aditmehta9 @aakarshvats638 @arnoob16

All 14 comments

Sir I would like to work on this issue, can you please elaborate for better understanding

Sir I would like to work on this issue, can you please elaborate for better understanding

Since you are already assigned first-timer issue this issue can't be assigned to you again so you have to claim another issue.

I would like to work on this issue if I am eligible as a first-timer.
Also, I would like to know where can one edit the templates as I've never worked with an Issue/PR Template.

I would like to work on this issue if I am eligible as a first-timer.
Also, I would like to know where can one edit the templates as I've never worked with an Issue/PR Template.

Sure @arnoob16 from this link you can learn about PR template https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/creating-a-pull-request-template-for-your-repository and from here you can know about issue template https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/configuring-issue-templates-for-your-repository

Sir I would like to work on this issue, can you please elaborate for better understanding

@isabelcosta I can't really explain it any better can you make changes that'll explain it better?

this issue have no description just template text, please provide full description. Thanks.

The idea here is for the placeholder text that comes with issue/PR template, to come commented out. So the idea is for the markdown provided in the template to, instead of:

# heading

placeholder text

(...)

be like:

# heading

<!-- placeholder text -->

(...)

this will make the text not show up when rendered by GitHub in the comments.

cc @epicadk @aditmehta9 @aakarshvats638 @arnoob16

@isabelcosta Should we also change the headings from bold to to header text .
Like currently

Is your feature request related to a problem? Please describe.
is in bold .

However I think if we change it to a header it would make the template more readable like so,

Is your feature request related to a problem? Please describe.

Unassigning @arnoob16 due to inactivity .
Please let us know if you would like to work again with this issue :)
Until then it's available for newcomers 馃殌

Can I work on this?? @vj-codes

@Sanika1999 yeah sure , can you confirm if you are contributing for the first time in this repo? I'll be happy to assign you after confirmation:)

Yes Iam a first time contributor for this repo @vj-codes

Assigning you @Sanika1999
Happy documenting !

I am still working on this will hopefully complete this by today.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

Kavya-24 picture Kavya-24  路  8Comments

devanshi7799 picture devanshi7799  路  8Comments

iofall picture iofall  路  3Comments

annabauza picture annabauza  路  7Comments

isabelcosta picture isabelcosta  路  4Comments