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

New documentation section needed: developer howto's #761

Open
3 of 9 tasks
hmpf opened this issue Apr 16, 2024 · 4 comments
Open
3 of 9 tasks

New documentation section needed: developer howto's #761

hmpf opened this issue Apr 16, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation META I contain multitudes

Comments

@hmpf
Copy link
Contributor

hmpf commented Apr 16, 2024

Suggested:

The "Release checklist" could probably also be in this section.

@hmpf hmpf added the documentation Improvements or additions to documentation label Apr 16, 2024
@hmpf hmpf changed the title New section needed: developer howto's New documentation section needed: developer howto's Apr 16, 2024
@johannaengland
Copy link
Contributor

I would argue that "How to use towncrier" is already documented, we only need "How to make a good changelog message"

@hmpf hmpf added the META I contain multitudes label Apr 17, 2024
@hmpf
Copy link
Contributor Author

hmpf commented Apr 25, 2024

Yeah we should move "How to use towncrier" to docs, out of README. But one or two files? Might be best to have

  • how to use towncrier to create a new message fragment (or not)
  • how to write a good changelog message
  • how to (and when) to write a good notes message

.. in one file.

@johannaengland
Copy link
Contributor

Yes, we can split the current towncrier documentation into two parts:
Add the last few details about build to the release procedure documentation
Add the rest to a Creating Pull Requests/Commits docs page

@hmpf
Copy link
Contributor Author

hmpf commented Apr 29, 2024

Another howto needed: split out how to override settings file from site-specific-settings.rst so that that file is only a list of settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation META I contain multitudes
Projects
Status: 🏗 In progress
Development

No branches or pull requests

2 participants