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.

Sign up for GitHub

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

Jump to bottom

Document versioning scheme in Dancer2::Policy #1685

Closed
yanick opened this issue Aug 17, 2023 · 6 comments
Closed

Document versioning scheme in Dancer2::Policy #1685

yanick opened this issue Aug 17, 2023 · 6 comments
Labels
Documentation Enhancement
Milestone
Dancer2 1.0.0

Comments

@yanick
Copy link
Contributor

yanick commented Aug 17, 2023

No description provided.

@cromedome
Copy link
Contributor

@yanick Dancer2::Policy is our SoC document. How about I rename GitGuide to Contributing, and include the versioning information there?

@cromedome
Copy link
Contributor

Let me ask this instead: do we add our versioning policy to this, or instead, just have Dancer2::Policy cover our standards of conduct, and rename the module to reflect this (to Dancer2::StandardsOfConduct)? It would make it extremely clear what's covered in the document, and be more consistent with what I am seeing in other projects these days.

@yanick
Copy link
Contributor Author

yanick commented Aug 21, 2023

cromedome++ for the more specific names. Dancer2::StandardsOfConduct and Dancer2::Contributing sounds good to me. I have no special feeling for any wording, but the more descriptive, the better it is!

@cromedome cromedome mentioned this issue Aug 22, 2023
Closed
@cromedome
Copy link
Contributor

@yanick updated contribution guidelines in #1691.

I am going one step further and documenting my release procedure in another PR. I'll create something akin to ReleasingDancer2.md, and document things there. As part of this, I'll link to semver.org and provide examples of how we will use it.

@cromedome cromedome added this to the Dancer2 1.0.0 milestone Aug 29, 2023
@cromedome
Copy link
Contributor

@yanick see also #1693, I think all the bases are covered now! I make reference to semver in the releasing document.

@cromedome
Copy link
Contributor

Considering this resolved with the merge of #1693.

cromedome added a commit that referenced this issue Oct 9, 2023
@cromedome
v1.0.0
ab2a50a 
    [ BUG FIXES ]
    * GH #1663: Allow overriding of prefix in add_route (GeekRuthie)
    * GH #1675: Stringify VERSION_FROM correctly in Makefile.PL (Jason
      A. Crome)
    * GH #1677: Don't deserialize multipart form data on post (Emil
      Perhinschi)
    * GH #1694: Update JS assets in Dancer2 app skel (Jason A. Crome)

    [ ENHANCEMENTS ]
    * PR #1682: Bump minimum version of Perl to 5.14 (Jason A. Crome)

    [ DOCUMENTATION ]
    * GH #1580: Document the purpose of the .dancer file (Jason A. Crome)
    * GH #1669: Show correct usage of Dancer2::Core::Error (GeekRuthie)
    * GH #1674: Fix POD for input_handle() (mauke)
    * GH #1414: Add documentation resources to the doc map (Jason A.
      Crome, Yanick Champoux)
    * PR #1684: Remove shumphrey from core developers (Steven Humphrey)
    * GH #1685: Document the versioning scheme and Dancer2 release
      process (Jason A. Crome)
    * PR #1688: Fixed various bugs/issues in Dancer2 Pod (Jason A. Crome)
    * PR #1691: Update the contribution guidelines (Jason A. Crome)
    * PR #1692: Change README extension .mkdn -> .md (Jason A. Crome)

    [ DEPRECATED ]
    * GH #1645: Deprecated Dancer2::Test (Jason A. Crome)
    * GH #1646: Deprecated keyword: push_header (Jason A. Crome)
    * GH #1647: Deprecated keyword: header (Jason A. Crome)
    * GH #1648: Deprecated keyword: headers (Jason A. Crome)
    * GH #1649: Deprecated keyword: context (Jason A. Crome)
    * GH #1650: Deprecated: splat/capture named placeholders (Jason A.
      Crome)
    * GH #1651: Deprecated core Request instance method:
      request->dispatch_path (Jason A. Crome)
    * GH #1652: Deprecated keyword in plugins: plugin_setting (Jason A.
      Crome)
    * GH #1653: Deprecated keyword in plugins: dancer_app (Jason A. Crome)
    * GH #1654: Deprecated keyword in plugins: request (Jason A. Crome)
    * GH #1655: Deprecated keyword in plugins: var (Jason A. Crome)
    * GH #1656: Deprecated keyword in plugins: hook (Jason A. Crome)

    [ MISC ]
    * GH #1659: Rename `master` branch to be `main` (Yanick Champoux)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Documentation Enhancement
Projects
None yet
Milestone
Dancer2 1.0.0
Development

No branches or pull requests
2 participants
@yanick @cromedome