Commit Graph

116 Commits

Author SHA1 Message Date
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
f1eae76bd0 Merge pull request #29 from jimeh/wording-formatting-improvements 2026-01-10 07:30:02 +00:00
c1aceee08a chore: minor wording and formatting improvements 2026-01-10 07:29:24 +00:00
155c354c50 Merge pull request #28 from jimeh/update-force-with-lease-link 2026-01-10 07:13:14 +00:00
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
5c18e04f90 Merge pull request #27 from jimeh/conventional-commits-guidelines 2026-01-10 07:00:47 +00:00
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
12daa305b3 Merge pull request #26 from jimeh/update-branch-terminology 2026-01-10 06:54:29 +00:00
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
be5f5dd71b Bump version to 1.0.0-rc.5 1.0.0-rc.5 2018-05-04 13:22:39 +01:00
db0232e3d2 Fix grammatical error 2018-05-04 13:21:47 +01:00
849d11e478 Move up Summary section above Terminology 2018-05-03 14:07:22 +01:00
b12361f619 Add an additional descriptive branch name example 2018-01-30 13:02:29 +00:00
d4f4f88009 Improve wording of Summary section 2018-01-30 13:02:17 +00:00
4c68267fb2 Add proper Summary section 2017-12-29 01:33:03 +00:00
b7a264b37a Rename Summary section to Introduction 2017-12-29 01:32:42 +00:00
4f6b8f8e15 Improve grammar and clarify reason for using PR's for help/feedback 2017-12-29 01:32:02 +00:00
aa896fa87d Minor rewording 2017-12-29 01:31:20 +00:00
af2ed13214 Update FAQ about descriptive names with ticket number recommendation 2017-12-29 01:30:31 +00:00
7cef6f71cc Change "off of" to "from", fixing #19 2017-12-28 21:40:47 +00:00
6f08b0e41c Merge pull request #16 from jimeh/update-license
Update CC BY license from 3.0 to 4.0
2017-10-08 13:54:32 +01:00
bfc57413ef Update CC BY license from 3.0 to 4.0 2017-10-08 13:48:52 +01:00
0388ab8ecb Update link to author's website. 2017-10-08 13:43:48 +01:00
9ee29c7e2a Bump version to 1.0.0-rc.4 1.0.0-rc.4 2017-08-29 02:02:52 +01:00
6bacc41545 Merge pull request #5 from jimeh/add-faq-section
Add FAQ Section
2017-08-29 01:58:23 +01:00
5f9513df4d Fix typo 2017-08-29 01:56:02 +01:00
741dda313e Improve grammar of descriptive name FAQ question 2017-08-29 01:56:02 +01:00
f4da274468 Fix typo 2017-08-29 01:56:02 +01:00
d3e6630e2e Improve style of FAQ section 2017-08-29 01:56:02 +01:00
6735136a5d Add answer to hotfix with broken master FAQ question 2017-08-29 01:56:02 +01:00
77332f5f9a Add answer to "what does describe name mean?" FAQ question 2017-08-29 01:56:02 +01:00
68e0502dac Add Common-Flow vs GitHub Flow FAQ question 2017-08-29 01:56:01 +01:00
927a00a7bd Add answer to Common-Flow vs Git Flow FAQ question 2017-08-29 01:56:01 +01:00
34cb2c20e0 Add Git Flow question 2017-08-29 01:56:01 +01:00
f7170875d0 Start work on FAQ section 2017-08-29 01:56:01 +01:00
6a56ee1c40 Merge pull request #13 from jimeh/allow-rebase-or-merge-update
Allow updating change branches via rebase or merge
2017-08-29 01:54:33 +01:00
610d131dd5 Minor rewording 2017-08-27 00:15:39 +01:00
0b2cde114a Enforce change branch update via rebase, allow merge if really needed 2017-08-27 00:15:39 +01:00
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
5cecf7dd84 Update terminology section to reflect recent changes to spec 2017-08-27 00:14:25 +01:00
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
399c5bf27a Recommend to not use a "v" prefix in release tags 2017-08-26 20:43:16 +01:00
eb1048f3c0 Fix grammar mistakes 2017-08-26 20:42:29 +01:00
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
31ee540bd9 Break apart first Change Branch requirement into four separate ones 2017-08-25 13:08:49 +01:00
efe86ce5ba Merge pull request #14 from jimeh/encourage-clean-git-history
Encourage a clean commit history within pull requests
2017-08-14 11:21:01 +01:00
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
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
7858131cf5 Merge pull request #12 from jimeh/optional-hard-coded-version
Make hard-coded version string and version bump commits optional
2017-08-04 12:15:14 +01:00
72335f9049 Make hard-coded version string and version bump commits optional 2017-07-30 02:48:45 +01:00