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

refactor: Better guide new user in CI news bot warning comment #220

Open
bobleesj opened this issue Dec 31, 2024 · 0 comments · May be fixed by Billingegroup/release-scripts#124
Open

refactor: Better guide new user in CI news bot warning comment #220

bobleesj opened this issue Dec 31, 2024 · 0 comments · May be fixed by Billingegroup/release-scripts#124
Milestone

Comments

@bobleesj
Copy link
Collaborator

bobleesj commented Dec 31, 2024

Problem

When there is no news, the new CI bot simply asks to include a news file using news/TEMPLATE.rst.

Screenshot 2024-12-31 at 10 14 43 AM

The current comment lacks (1) good examples, (2) the new practice of No news: .., and (3) doesn't guide where to place the news under, etc. changed, fixed, etc. This isn't a big deal for us (BG group) since we have a separate GitLab page but it might be a source of confusion for those adopting our current cookiecutter and new contributors contributing to their cookiecuttered packages.

Proposed solution

In the bot comment, improve wording and add a link to the section in the cookiecutter doc once deployed:

Screenshot 2024-12-31 at 10 11 55 AM
@bobleesj bobleesj changed the title feat: better guide new user in news CI news bot command by feat: better guide new user in CI news bot warning comment Dec 31, 2024
@bobleesj bobleesj changed the title feat: better guide new user in CI news bot warning comment refactor: better guide new user in CI news bot warning comment Dec 31, 2024
@bobleesj bobleesj added this to the 0.1.0 release milestone Dec 31, 2024
@bobleesj bobleesj changed the title refactor: better guide new user in CI news bot warning comment refactor: Better guide new user in CI news bot warning comment Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant