Skip to content

Add git guide#2106

Open
bettio wants to merge 1 commit intoatomvm:mainfrom
bettio:git-guide
Open

Add git guide#2106
bettio wants to merge 1 commit intoatomvm:mainfrom
bettio:git-guide

Conversation

@bettio
Copy link
Collaborator

@bettio bettio commented Feb 16, 2026

A practical guide about how to make commits and PRs for this project.

These changes are made under both the "Apache 2.0" and the "GNU Lesser General
Public License 2.1 or later" license terms (dual license).

SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later

A practical guide about how to make commits and PRs for this project.

Signed-off-by: Davide Bettio <davide@uninstall.it>
Copy link
Collaborator

@UncleGrumpy UncleGrumpy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks very helpful, but we should also make sure it gets included in the published documentation by adding it to doc/CmakeLists.txt around here:

file(COPY ${CMAKE_SOURCE_DIR}/C_CODING_STYLE.md DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/src)

It will be good to have this published, then the other AtomVM.org repos can just add a link to it in their readme or contribution guidelines.

# repeat until finished
```

### G. Sign-off (DCO style, optional)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAIK we don't make it optional


Rules:

* Max 50 characters.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should automate these rules in CI (especially to catch when I am too verbose in titles)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had a similar thought. I also wonder about using a pull request template.

This comment was marked as outdated.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thread T-019c6ce1-156b-722d-bd0e-f6515169196d is not shared with you

I'm not sure we had first line of commit messages this wide.

This comment was marked as outdated.

Copy link
Contributor

@petermm petermm Feb 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

commit-title-stats.sh

figured out I needed to filter out "Merge pull request #.."

Still suggest 50 char recommendation with a 72 hard limit..

Commit subject line length (characters) — last 12 months, excluding merge PRs

Contributor Commits P25 P50 P75 P90 P95 Max >50 %>50
Paul Guyot 509 32 41 51 59 64 87 136 26.7%
Davide Bettio 248 38 45 53 61 67 72 84 33.9%
Winford 42 36 50 57 62 65 98 20 47.6%
Peter M 42 27 37 45 52 56 61 5 11.9%
Jakub Gonet 21 20 24 36 46 46 49 0 0.0%
TOP 5 TOTAL 862 33 43 52 60 64 98 245 28.4%

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you. I agree with your point. We can transition to more git messaging discipline but we'll definitely need some help from an automated tool :-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants