WIP: add formatting doc and pre-commit #7

Draft
enot wants to merge 3 commits from docs-formatting into main
Collaborator

This is a quick start, we can change it all or just some.

I'm not certain how to create the pre-commit hook for windows, I think bash works on MacOS? Any help is appreciated and feel free to push to this branch.

Closes #6

This is a quick start, we can change it all or just some. I'm not certain how to create the pre-commit hook for windows, I think bash works on MacOS? Any help is appreciated and feel free to push to this branch. Closes #6
enot added 1 commit 2023-10-19 20:42:25 -04:00
enot added 1 commit 2023-10-19 20:44:14 -04:00
enot changed title from add formatting doc and pre-commit to WIP: add formatting doc and pre-commit 2023-10-20 09:18:45 -04:00
enot force-pushed docs-formatting from 57610d69dc to cb07f81a1f 2023-10-20 12:01:14 -04:00 Compare
cascode reviewed 2023-10-21 04:36:37 -04:00
CONTRIBUTING.md Outdated
@ -0,0 +27,4 @@
If you want to think about formatting your code less and just have git yell at you whe you try to commit code that is not properly formatted, you can use a simple pre-commit hook.
After cloning the repo, the file `pre-commit` to `.git/hooks/pre-commit`. That's it.
Collaborator

missing a verb in this line?

missing a verb in this line?
Author
Collaborator

Indeed, thank you.

Indeed, thank you.
enot marked this conversation as resolved
enot force-pushed docs-formatting from cb07f81a1f to 57610d69dc 2023-10-21 19:03:34 -04:00 Compare
enot added 1 commit 2023-10-21 19:26:20 -04:00
316b67c596
Fix typo and add rust market links
Adds links to the rust meta extension and the VScode rust page
enot force-pushed docs-formatting from 316b67c596 to 136da63d00 2023-10-21 19:28:37 -04:00 Compare
Author
Collaborator

Any suggestions on a folder to use for things like the pre commit hook?

Also wondering if this commit should format the existing code since it is not currently.

Any suggestions on a folder to use for things like the pre commit hook? Also wondering if this commit should format the existing code since it is not currently.
This pull request is marked as a work in progress.
This branch is out-of-date with the base branch
You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.
git checkout -b docs-formatting main
git pull origin docs-formatting

Step 2:

Merge the changes and update on Gitea.
git checkout main
git merge --no-ff docs-formatting
git push origin main
Sign in to join this conversation.
No reviewers
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: MountainTownTechnology/aural_isle#7
No description provided.