Skip to content

Conversation

@daniellepintz
Copy link
Contributor

@daniellepintz daniellepintz commented Aug 17, 2021

This will allow people to create an issue for a refactor or deprecation

What does this PR do?

Currently if someone wants to make an issue for a refactoring or deprecation there is no option for this in the issue templates. This PR creates a template for a refactor/deprecation

Discussed in slack: https://app.slack.com/client/TR9DVT48M/C01296PBDQV/thread/C01296PBDQV-1629162951.025000

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

This will allow people to create an issue for a refactor or deprecation
@codecov
Copy link

codecov bot commented Aug 17, 2021

Codecov Report

Merging #8960 (a1f291c) into master (77bc5d4) will decrease coverage by 4%.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #8960    +/-   ##
=======================================
- Coverage      92%     89%    -4%     
=======================================
  Files         176     175     -1     
  Lines       14394   14402     +8     
=======================================
- Hits        13275   12762   -513     
- Misses       1119    1640   +521     

@yifuwang
Copy link
Contributor

This looks great! Thanks for proposing this.

Would it be better to call this "improvement" instead? IMHO refactoring is a means for improvement but itself is not an end.

@daniellepintz
Copy link
Contributor Author

Good call @yifuwang how about "Code Improvement"? That encapsulates deprecation and refactoring

@daniellepintz daniellepintz changed the title Create refactor.md Add an issue template for Code Improvement Aug 17, 2021
@yifuwang
Copy link
Contributor

Thanks @daniellepintz! This sounds great

Copy link
Contributor

@ananthsub ananthsub left a comment

Choose a reason for hiding this comment

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

Looks reasonable to me! And glad that we're capturing these separately from bug reports and feature requests

@mergify mergify bot added the ready PRs ready to be merged label Aug 18, 2021
@justusschock justusschock enabled auto-merge (squash) August 18, 2021 08:27
Copy link
Collaborator

@Borda Borda left a comment

Choose a reason for hiding this comment

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

feeling a bit confused, this looks almost the same as the feature request...

@daniellepintz
Copy link
Contributor Author

@Borda you are right, it is almost the same. But this way when creating an issue there is an option for code improvement, as currently a lot of issues don't fall under the "feature" or "bug fix" category. One alternative is we could rename "Feature" to something to encapsulate feature, refactoring, and deprecation, but it might be a bit strange to just have a generic catch-all category. wdyt?

@Borda Borda added the docs Documentation related label Aug 19, 2021
Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
auto-merge was automatically disabled August 19, 2021 18:18

Head branch was pushed to by a user without write access

@daniellepintz
Copy link
Contributor Author

@Borda @tchaton @edenlightning looks like I need a review from one of you to merge this. wdyt?

@tchaton tchaton enabled auto-merge (squash) August 21, 2021 10:39
@tchaton tchaton merged commit 92e4979 into Lightning-AI:master Aug 21, 2021
@daniellepintz daniellepintz deleted the patch-1 branch August 21, 2021 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants