Skip to content

Add New Issue and Pull Request Templates - #1827

Merged
steven-esser merged 4 commits into
aboutcode-org:developfrom
AyanSinhaMahapatra:issue-template
Nov 25, 2019
Merged

Add New Issue and Pull Request Templates#1827
steven-esser merged 4 commits into
aboutcode-org:developfrom
AyanSinhaMahapatra:issue-template

Conversation

@AyanSinhaMahapatra

Copy link
Copy Markdown
Member

Fixes #1814

Signed-off-by: Ayan Sinha Mahapatra ayansmahapatra@gmail.com

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
@AyanSinhaMahapatra

AyanSinhaMahapatra commented Nov 11, 2019

Copy link
Copy Markdown
Member Author

Would Look like this.

Also, note that we'd have to add https://github.com/apps/welcome (added .github/config.yml for the same).

Note that related Documentation is being added in aboutcode-org/aboutcode#33 and so some of the links will have to be changed later. (Added to #1813 )

@pombredanne

Copy link
Copy Markdown
Member

I really like the way this looks! 🙇‍♂️
Let's gather a bit of community feedback before we merge.

Comment thread .github/ISSUE_TEMPLATE/--bug-report.md Outdated
@steven-esser

Copy link
Copy Markdown
Contributor

@AyanSinhaMahapatra I like this as well, but I am a little confused as to where/how the various templates show up to the end user. How do these issue templates work exactly?

@pombredanne

pombredanne commented Nov 11, 2019

Copy link
Copy Markdown
Member

@MaJuRG @AyanSinhaMahapatra posted that list https://github.com/AyanSinhaMahapatra/sphinx-test/issues/new/choose to show how this would look.

@mjherzog FYI
what Ayan is suggesting is using Github built in feature to provide that doc in place in each repo.... We could of course have it in a central lace too (and that central place being the reference and copied to each repo?)
Would you prefer to have a central doc too?

@steven-esser

Copy link
Copy Markdown
Contributor

@pombredanne I like the idea of having it in each repo. At least the basics for opening a bug report or feature request.

@mjherzog

Copy link
Copy Markdown
Member

My concern is that this type of documentation should apply to all of our projects and is likely not tied to the versioning for any specific project. I think that this means that this should be AboutCode level documentation that is propagated down to each project repo.

@steven-esser

Copy link
Copy Markdown
Contributor

@mjherzog Sure, I think having contributor docs for our organization in general should be in an aboutcode top level repo. My comment was more in regards to the basic issue template skeleton that can be copied into all our repos (Bug Report, Feature Request, etc).

@AyanSinhaMahapatra

AyanSinhaMahapatra commented Nov 12, 2019

Copy link
Copy Markdown
Member Author

@pombredanne @mjherzog @MaJuRG By docs here do you mean docs related to these Issue Templates?

@AyanSinhaMahapatra

Copy link
Copy Markdown
Member Author

Note that related Documentation is being added in aboutcode-org/aboutcode#33 and so some of the links will have to be changed later. (Added to #1813 )

On docs, here I meant documentation mainly on the Good First Issue/First Timers Only guides which I'm adding for review and not other contributor docs in general.

Also, should I initiate basic issue templates for bug-report and feature-request in other main repositories?

@steven-esser

Copy link
Copy Markdown
Contributor

@AyanSinhaMahapatra I think by docs/ we mean general documentation about how to contribute to our projects and other general OSS development guidelines. @mjherzog I think this is what you mean?

As far as I know, we need to have the Issue Templates in each repo for this GitHub feature to work.

@sesser

sesser commented Nov 12, 2019

Copy link
Copy Markdown

Unsubscribe

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

@steven-esser steven-esser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me @pombredanne

@steven-esser
steven-esser merged commit 9202df4 into aboutcode-org:develop Nov 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Old Issue Template

6 participants