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

Rewrite paragraphs about towncrier. #2565

Merged
merged 6 commits into from
May 12, 2024

Conversation

StyXman
Copy link
Contributor

@StyXman StyXman commented May 11, 2024

The original text:

  • had a very roundabout way to explain what the filename for the file in the changes/ directory should look like.
  • relied upon towncriers doc to explain fragment types.

In my view this made first/drive by PRs more difficult to properly do, so I expanded the text a little so it's more explicit.

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@StyXman
Copy link
Contributor Author

StyXman commented May 11, 2024

changes file coming.

@StyXman
Copy link
Contributor Author

StyXman commented May 11, 2024

I hope I got it right this time.

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

The CI failures you were seeing were due to pre-commit identifying blank space at the end of lines; if you install pre-commit (see the contribution docs for details), those problems will be picked up automatically.

I've made some additional clarifications; but this was really helpful as a first draft. Thanks for the contribution!

@freakboy3742 freakboy3742 merged commit e81de35 into beeware:main May 12, 2024
31 of 34 checks passed
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