Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change step with new_cop command for rubocop-rspec #1891

Merged
merged 1 commit into from
May 24, 2024
Merged

Conversation

ydah
Copy link
Member

@ydah ydah commented May 24, 2024

before:

Do 4 steps:
  1. Modify the description of RSpec/CopName in config/default.yml
  2. Implement your new cop in the generated file!
  3. Commit your new cop with a message such as
     e.g. "Add new `RSpec/CopName` cop"
  4. Run `bundle exec rake changelog:new` to generate a changelog entry

after:

Do 4 steps:
  1. Modify the description of RSpec/CopName in config/default.yml
  2. Implement your new cop in the generated file!
  3. Add an entry about new cop to CHANGELOG.md
  4. Commit your new cop with a message such as
     e.g. "Add new `RSpec/CopName` cop"

Before submitting the PR make sure the following are checked:

  • Feature branch is up-to-date with master (if not - rebase it).
  • Squashed related commits together.
  • [-] Added tests.
  • [-] Updated documentation.
  • [-] Added an entry to the CHANGELOG.md if the new code introduces user-observable changes.
  • The build (bundle exec rake) passes (be sure to run this locally, since it may produce updated documentation that you will need to commit).

@ydah ydah requested a review from a team as a code owner May 24, 2024 06:38
1. Modify the description of #{badge} in config/default.yml
2. Implement your new cop in the generated file!
3. Commit your new cop with a message such as
e.g. "Add new `#{badge}` cop"
Copy link
Member

Choose a reason for hiding this comment

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

4 and 3 feel out of order. For our parent project it’s justifiable, they need the pr number in the changelog entry? For us, changelog can be added first if you follow the changelog-driven development approach 😅

Copy link
Member Author

Choose a reason for hiding this comment

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

That's true. Well, I don't think it's going to be a big problem, especially if the order goes back and forth, so I switched 3 and 4.

Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

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

Thanks!

before:
```
Do 4 steps:
  1. Modify the description of RSpec/CopName in config/default.yml
  2. Implement your new cop in the generated file!
  3. Commit your new cop with a message such as
     e.g. "Add new `RSpec/CopName` cop"
  4. Run `bundle exec rake changelog:new` to generate a changelog entry
```

after:
```
Do 4 steps:
  1. Modify the description of RSpec/CopName in config/default.yml
  2. Implement your new cop in the generated file!
  3. Add an entry about new cop to CHANGELOG.md
  4. Commit your new cop with a message such as
     e.g. "Add new `RSpec/CopName` cop"
```
@pirj pirj merged commit 57f88c4 into master May 24, 2024
25 checks passed
@pirj pirj deleted the add-generator branch May 24, 2024 08:08
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.

2 participants