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.

We have to be thorough when upgrading dependencies. In order to democratize this process, we should provide a clear contribution path for those (like me) who wish to help.

  • Mention steps / requirements for dependency updates
  • Provide a template for each added rule (e.g. following the same outline as below)
- **eslint-config-prettier:** [`v2.6.0...v2.9.0`](https://github.com/prettier/eslint-config-prettier/compare/v2.6.0...v2.9.0)
  - Added: The [implicit-arrow-linebreak] rule
  - Added: The [react/jsx-one-expression-per-line] rule.
  - Added: The [lines-around-comment] rule (as a [special
    rule][lines-around-comment-special]).
  - Added: The [no-unexpected-multiline] rule (as a [special
    rule][no-unexpected-multiline-special]).
  • Require a changelog update
  • For important/breaking changes: require the upgrade path to be documented

Do you see anything else? cc @GoodForOneFare @ismail-syed @lemonmade

Issue Analytics

  • State:closed
  • Created 6 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
atesgoralcommented, Sep 11, 2020

@alexandcote Can this be closed with #181 or is there more work to be done?

0reactions
kaeligcommented, Jan 9, 2018

Thanks for the feedback, guys.

Regarding the upgrade path, it could be as simple as:

screenshot 2018-01-09 11 58 03

Does this not seem useful?


We’re going to merge this repo back into Shopify/javascript, and I think Github won’t handle folder-specific PR templates

I didn’t know about that. Thanks!


Are these for custom Shopify rules, or when we bump a dependency and add a new rule that was introduced?

@ismail-syed probably both?

I’ve edited the issue to show what it may look like

Read more comments on GitHub >

github_iconTop Results From Across the Web

Creating a pull request template for your repository
Adding a pull request template · On GitHub.com, navigate to the main page of the repository. · Above the list of files, using...
Read more >
GitHub pull request template - Axolo
The easiest way to add a pull request template to your repository is by adding a file called pull_request_template.md in the root of...
Read more >
How to Enhance Pull Requests Using Templates - GitKraken
How to Create Multiple Pull Request Templates in GitHub · Create a folder named PULL_REQUEST_TEMPLATE and place it within either the root directory...
Read more >
A GitHub Pull Request Template for Your Projects
It's quite easy to generate a PR template for your project. Simply create a file named PULL_REQUEST_TEMPLATE and place it one of three...
Read more >
How to create a Github Pull Request Template - The Tara Blog
Step 1. Head over to your GitHub Repo · Step 2. Selecting your Template creation method · Step 3a. Uploading your GitHub Pull...
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