question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Implement Issue and PR templates

See original GitHub issue

As suggested by @brechmos-stsci , it might be beneficial to give users a check list when they open a new issue or a new pull request (the latter should be consistent with existing dev guide). A first draft could be obtained from existing sources, for example https://www.talater.com/open-source-templates .

For instance, choosing new issue, bug + feature request, and backend brought me to https://www.talater.com/open-source-templates/#/page/98

<!--- Provide a general summary of the issue in the Title above -->

## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->

## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->

## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->

## Steps to Reproduce (for bugs)
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
1.
2.
3.
4.

## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Version used:
* Environment name and version (e.g. PHP 5.4 on nginx 1.9.1):
* Server type and version:
* Operating System and version:
* Link to your project:

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Reactions:2
  • Comments:11 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
agarwalrounakcommented, Jan 25, 2019

@pllim I don’t think that only admins can make those templates. All we have to do is create files named ISSUE_TEMPLATE.md and PULL_REQUEST_TEMPLATE.md, and store them in .github folder but as @bsipocz mentioned, I should perhaps solve a good first issue and then move to this one.

1reaction
MSeifert04commented, Jan 25, 2019

I think what @mhvk means is what we also have in ccdproc as file Templates (https://github.com/astropy/ccdproc/tree/master/.github).

Official github docs about them: https://help.github.com/articles/manually-creating-a-single-issue-template-for-your-repository/

Read more comments on GitHub >

github_iconTop Results From Across the Web

Configuring issue templates for your repository
Creating issue templates ... Under your repository name, click Settings. ... In the "Features" section, under "Issues," click Set up templates. ... Use...
Read more >
GitHub pull request template
Pull request templates allow your organizations to have a default text when you create a pull request on GitHub. It is quite useful...
Read more >
Multiple issue and pull request templates
Issue and pull request templates help teams gather the right information from the beginning of a thread, but sometimes one template just isn't ......
Read more >
Sharing GitHub Issue & Pull Request Templates
GitHub has a hidden trick that allows for sharing PR & issue templates.
Read more >
GitHub Pull Request and Issue Templates
My coworkers and I have developed some techniques to handle the communication opportunity of a PR or issue. Here are the templates we...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found