jimeh/common-flow
1
0
Fork 0
mirror of https://github.com/jimeh/common-flow.git synced 2026-02-19 09:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
122 Commits 1 Branch 16 Tags
e38a08b2653d206dbf4b9f7dac003337a435a5bc
Commit Graph

102 Commits

Author SHA1 Message Date
Jim Myhrberg
e38a08b265 feat(releases): allow release tags on merge commits for PR-based releases 
Add support for release pull requests as an optional workflow. When
usingrelease PRs, the release tag SHOULD be placed on the resulting
merge commitrather than the version bump commit itself.

Changes:

- Add new item 7.5 defining release pull requests
- Update item 7.4 to reference the release PR exception
- Update item 8.6 to allow tagging merge commits for release branch PRs
- Renumber items 7.5-7.9 to 7.6-7.10
 2026-01-12 08:59:11 +00:00
Jim Myhrberg
27fafc85e4 refactor(spec): reorder specification sections for better flow 
Move Git Best Practices from section 10 to section 5, placing it after
Pull Requests and before Versioning. This positions best practices for
commits, rebasing, and force-pushing earlier in the document where they
are more relevant to daily development work.

- Renumber sections 5-9 to 6-10
- Update cross-reference in section 7.2 (section 5.1 → 6.1)
- Normalize "Long-term" to "Long-Term" for consistency
 2026-01-12 08:59:11 +00:00
Jim Myhrberg
89094a20a0 feat(faq): add guidance for handling monorepos 
Expand FAQ section to provide clear strategies for managing monorepos
using Common-Flow. Cover key considerations such as branch management,
versioning approaches, and maintaining consistency across packages.
 2026-01-12 08:59:11 +00:00
Jim Myhrberg
798ef4fced chore(format): convert markdown headings to atx-style 
refactor markdown formatting in the common-flow.md document by:
- Replacing setext-style headings with atx-style headings
- Maintaining overall document structure and readability
 2026-01-12 08:59:11 +00:00
Jim Myhrberg
b0a7633162 feat: initial set of rework to prepare a v2 of Common-Flow 2026-01-12 08:59:11 +00:00
Jim Myhrberg
c471aa9b37 fix(links): update link URLs 
Update links to newer URLs, so they no longer point to dead URLs.
 2026-01-10 18:23:59 +00:00
Jim Myhrberg
c1aceee08a chore: minor wording and formatting improvements 2026-01-10 07:29:24 +00:00
Jim Myhrberg
ed5db9db18 fix(best-practices): replace force-with-lease article link 
Replace the dead Atlassian blog link with a newer and more comprehensive
explanation of `git push --force-with-lease`, providing clearer context
for developers about this important git workflow practice.
 2026-01-10 07:12:07 +00:00
Jim Myhrberg
06d46881da feat(commits): update commit message guidelines to use conventional commits 
Update guidelines for commit messages to recommend Conventional
Commits specification. Clarify best practices for version bumps,
breaking changes, and semantic versioning alignment. Emphasize
benefits of structured commit messages for changelog generation
and automated version determination.
 2026-01-10 06:59:35 +00:00
Jim Myhrberg
613f707ffe feat(terminology): replace "master" with "main" branch terminology 
Update documentation to use "main" branch instead of "master" branch
throughout the document. This change reflects modern conventions.
 2026-01-10 06:53:42 +00:00
Jim Myhrberg
db0232e3d2 Fix grammatical error 2018-05-04 13:21:47 +01:00
Jim Myhrberg
849d11e478 Move up Summary section above Terminology 2018-05-03 14:07:22 +01:00
Jim Myhrberg
b12361f619 Add an additional descriptive branch name example 2018-01-30 13:02:29 +00:00
Jim Myhrberg
d4f4f88009 Improve wording of Summary section 2018-01-30 13:02:17 +00:00
Jim Myhrberg
4c68267fb2 Add proper Summary section 2017-12-29 01:33:03 +00:00
Jim Myhrberg
b7a264b37a Rename Summary section to Introduction 2017-12-29 01:32:42 +00:00
Jim Myhrberg
4f6b8f8e15 Improve grammar and clarify reason for using PR's for help/feedback 2017-12-29 01:32:02 +00:00
Jim Myhrberg
aa896fa87d Minor rewording 2017-12-29 01:31:20 +00:00
Jim Myhrberg
af2ed13214 Update FAQ about descriptive names with ticket number recommendation 2017-12-29 01:30:31 +00:00
Jim Myhrberg
7cef6f71cc Change "off of" to "from", fixing #19 2017-12-28 21:40:47 +00:00
Jim Myhrberg
bfc57413ef Update CC BY license from 3.0 to 4.0 2017-10-08 13:48:52 +01:00
Jim Myhrberg
0388ab8ecb Update link to author's website. 2017-10-08 13:43:48 +01:00
Jim Myhrberg
5f9513df4d Fix typo 2017-08-29 01:56:02 +01:00
Jim Myhrberg
741dda313e Improve grammar of descriptive name FAQ question 2017-08-29 01:56:02 +01:00
Jim Myhrberg
f4da274468 Fix typo 2017-08-29 01:56:02 +01:00
Jim Myhrberg
d3e6630e2e Improve style of FAQ section 2017-08-29 01:56:02 +01:00
Jim Myhrberg
6735136a5d Add answer to hotfix with broken master FAQ question 2017-08-29 01:56:02 +01:00
Jim Myhrberg
77332f5f9a Add answer to "what does describe name mean?" FAQ question 2017-08-29 01:56:02 +01:00
Jim Myhrberg
68e0502dac Add Common-Flow vs GitHub Flow FAQ question 2017-08-29 01:56:01 +01:00
Jim Myhrberg
927a00a7bd Add answer to Common-Flow vs Git Flow FAQ question 2017-08-29 01:56:01 +01:00
Jim Myhrberg
34cb2c20e0 Add Git Flow question 2017-08-29 01:56:01 +01:00
Jim Myhrberg
f7170875d0 Start work on FAQ section 2017-08-29 01:56:01 +01:00
Jim Myhrberg
610d131dd5 Minor rewording 2017-08-27 00:15:39 +01:00
Jim Myhrberg
0b2cde114a Enforce change branch update via rebase, allow merge if really needed 2017-08-27 00:15:39 +01:00
Jim Myhrberg
4fd8d2f639 Allow updating change branches via rebase or merge 
Allow for pulling in changes from the source branch either via
rabasing or merging, instead of only allowing rebasing. Rebasing is
still recommended however.
 2017-08-27 00:15:39 +01:00
Jim Myhrberg
5cecf7dd84 Update terminology section to reflect recent changes to spec 2017-08-27 00:14:25 +01:00
Jim Myhrberg
045eded571 Swap order of "git add -i" and "git add -p" 
Using the -p option is a shorthand to get into the patch section of
interactive mode. Hence the -i option is the main one to use.
 2017-08-26 20:45:39 +01:00
Jim Myhrberg
399c5bf27a Recommend to not use a "v" prefix in release tags 2017-08-26 20:43:16 +01:00
Jim Myhrberg
eb1048f3c0 Fix grammar mistakes 2017-08-26 20:42:29 +01:00
Jim Myhrberg
264e5c3ee9 Be a bit less strict about separate branches for each change 
Basically, there might very well be valid reasons to roll one change
into another if one is dependant on the other, even if they're
technically distinctly different changes. Ideally this shouldn't
happen, but let's at least allow it if really needed.
 2017-08-25 13:11:33 +01:00
Jim Myhrberg
31ee540bd9 Break apart first Change Branch requirement into four separate ones 2017-08-25 13:08:49 +01:00
Jim Myhrberg
7b90cfd10d Encourage a clean commit history within pull requests 
And also make it more obvious what pull requests are intended for.

Should address #11.
 2017-08-08 21:42:56 +01:00
Jim Myhrberg
62f817a5ea Update release branch sections 
- Fixes #9
- Restructures "Release Branches" section with it's sub-sections into
  two separate top-level sections for short-term and long-term release
  branches.
 2017-08-08 20:50:55 +01:00
Jim Myhrberg
72335f9049 Make hard-coded version string and version bump commits optional 2017-07-30 02:48:45 +01:00
Chris Connelly
5179942226 Fix capitalisation of RFC 2119 key word 2017-07-25 11:19:23 +01:00
Michael Pavling
4b4fa6d8b9 adding to the recommendation of doing an interactive 'git add' to show the shortcut to patching 2017-07-25 09:07:51 +01:00
Jim Myhrberg
34e846590c Link directly to Commit Guidelines section 2017-07-12 14:38:50 +01:00
Jim Myhrberg
e71ed502ca Reword summary slightly 2017-07-12 14:38:40 +01:00
Jim Myhrberg
40bfd924d4 Pre-release releases are not safe for production use 2017-07-10 21:13:01 +01:00
Jim Myhrberg
7ed4cdf687 Remove "bleeding edge" terminology 
The term "bleeding edge", and it's less scary sibling "leading edge"
both mean slightly different things to different people. Hence we're
removing it in favor of attempting to fully explain how the master
branch should be considered.
 2017-07-10 21:00:45 +01:00