starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-11 20:00:28 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

Create changelog, Issue and PR template #84

New Issue
Closed
opened 2025-12-29 01:21:57 +01:00 by adam · 5 comments
adam commented 2025-12-29 01:21:57 +01:00
Owner
Copy Link

Originally created by @kradalby on GitHub (Nov 28, 2021).

@cure rightfully pointed out that we really need a changelog, 0.12.0 is ramping up to be a large release with many breaking changes and having just the included commits is no longer viable.

In addition, we should have PR and Issue templates to make sure users and contributes have a checklist of what to include.

Changelog

I suggest having a file CHANGELOG.md which has a format like:

**0.12.0:**

**BREAKING**:
- Feature [Link to PR]
- Feature [Link to PR]

**Changes**:
- Feature [Link to PR]
- Feature [Link to PR]

Where the version to be released is on top and people add their entry as part of their PR.

Feedback appreciated.

Issue template

Find a good example of another project, require OS, version, and information about the setup for most things. Some gist with log output.

PR template

Have a description and checklist?

For example:

  • Added unit tests
  • Added integration tests
  • Updated documentation
  • Updated CHANGELOG.md

Checklist must not all be checked, just more to remind people on what needs to be done

Thoughts? @juanfont @cure @ohdearaugustin

Originally created by @kradalby on GitHub (Nov 28, 2021). @cure rightfully pointed out that we really need a changelog, 0.12.0 is ramping up to be a large release with many breaking changes and having just the included commits is no longer viable. In addition, we should have PR and Issue templates to make sure users and contributes have a checklist of what to include. ### Changelog I suggest having a file `CHANGELOG.md` which has a format like: ```markdown **0.12.0:** **BREAKING**: - Feature [Link to PR] - Feature [Link to PR] **Changes**: - Feature [Link to PR] - Feature [Link to PR] ``` Where the version _to be released_ is on top and people add their entry as part of their PR. Feedback appreciated. ### Issue template Find a good example of another project, require OS, version, and information about the setup for most things. Some gist with log output. ### PR template Have a description and checklist? For example: - [ ] Added unit tests - [ ] Added integration tests - [ ] Updated documentation - [ ] Updated CHANGELOG.md Checklist must not all be checked, just more to remind people on what needs to be done Thoughts? @juanfont @cure @ohdearaugustin
adam added the enhancementhelp wantedgood first issuedocumentation labels 2025-12-29 01:21:57 +01:00
adam closed this issue 2025-12-29 01:21:58 +01:00
adam commented 2025-12-29 01:21:58 +01:00
Author
Owner
Copy Link

@dragetd commented on GitHub (Nov 29, 2021):

An initial CHANGES.md is IMHO a separate issue than the ISSUE/PR template. But I'd love to have go at this, if I may :-)

@dragetd commented on GitHub (Nov 29, 2021): An initial CHANGES.md is IMHO a separate issue than the ISSUE/PR template. But I'd love to have go at this, if I may :-)
adam commented 2025-12-29 01:21:59 +01:00
Author
Owner
Copy Link

@kradalby commented on GitHub (Nov 29, 2021):

Yes please. I Will probably do the changes part this evening, and I would appreciate a proposal for the templates if your up for it :)

@kradalby commented on GitHub (Nov 29, 2021): Yes please. I Will probably do the changes part this evening, and I would appreciate a proposal for the templates if your up for it :)
adam commented 2025-12-29 01:21:59 +01:00
Author
Owner
Copy Link

@dragetd commented on GitHub (Nov 29, 2021):

PR here #243

@dragetd commented on GitHub (Nov 29, 2021): PR here #243
adam commented 2025-12-29 01:22:00 +01:00
Author
Owner
Copy Link

@kradalby commented on GitHub (Dec 7, 2021):

This has been implemented, now the continuous work is left.

@kradalby commented on GitHub (Dec 7, 2021): This has been implemented, now the continuous work is left.
adam commented 2025-12-29 01:22:00 +01:00
Author
Owner
Copy Link

@ohdearaugustin commented on GitHub (Feb 25, 2022):

I guess we can close this issue then.

@ohdearaugustin commented on GitHub (Feb 25, 2022): I guess we can close this issue then.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label documentation enhancement good first issue help wanted
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#84
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?