Argus icon indicating copy to clipboard operation
Argus copied to clipboard

New documentation section needed: developer howto's

Open hmpf opened this issue 1 year ago • 4 comments

Suggested:

  • [ ] How to develop with docker
  • [ ] How to develop directly on the command line
  • [ ] How to triage tickets and PR's (what labels are important!)
  • [ ] How to use towncrier and make a good changelog message
  • [x] #818
  • [ ] How to do pull-requests
  • [ ] How to merge
  • [x] #764
  • [x] #802

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

hmpf avatar Apr 16 '24 11:04 hmpf

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

johannaengland avatar Apr 17 '24 06:04 johannaengland

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.

hmpf avatar Apr 25 '24 10:04 hmpf

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

johannaengland avatar Apr 25 '24 11:04 johannaengland

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.

hmpf avatar Apr 29 '24 08:04 hmpf