search

rems-project / cn-tutorial

8 stars 8 forks source link

Adds style guide and naming conventions #93

Closed thatplguy closed 1 month ago

thatplguy commented 1 month ago

Adds a style guide for CN style and naming conventions to distinguish between CN identifiers and C identifiers.

There will be changes to the style guide shortly. See comments in this PR for more details: https://github.com/rems-project/cn-tutorial/pull/84

Context

This PR replaces #84 – it rebases against origin/main and squashes the history from #84 into a single commit. It also incorporates the latest changes to origin/main (@dc-mak's VIP work). Should be ready to merge.

To review the differences with naming-conventions-2, run

git pull
git diff naming-conventions-2 cns/naming-conventions-2

Here's what I did to create this branch:

// Create this branch from the latest naming-conventions-2
git checkout naming-conventions-2
git pull
git checkout -b cns/naming-conventions-2

// Squash all commits on this branch into one
git rebase -i 3453f6889c53af99f1bfad2f787d413907b8e483

// ... fix several merge conflicts ...

// Rebase on origin/main to pick up Dhruv's VIP changes
git pull --rebase origin main

// ... fix a few more conflicts ...