aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Schofield <git@ajschof.me>2024-08-12 10:44:13 +0100
committerAlex Schofield <git@ajschof.me>2024-08-12 10:44:13 +0100
commit4fcbc76300d0bead135f74add5963583896123a8 (patch)
treeddbd0e29f4a5dcf1edbeb37641d2ecc62c63a9a9
parent19cd19b68cbd063ced675d63eab6b49983be89d9 (diff)
downloadde-project-bentley-4fcbc76300d0bead135f74add5963583896123a8.tar.gz
de-project-bentley-4fcbc76300d0bead135f74add5963583896123a8.zip
docs: add markdown extension
-rw-r--r--DEVNOTES55
1 files changed, 0 insertions, 55 deletions
diff --git a/DEVNOTES b/DEVNOTES
deleted file mode 100644
index 00f06ec..0000000
--- a/DEVNOTES
+++ /dev/null
@@ -1,55 +0,0 @@
-# Workflow
-
-## Commits
-
-### Make small and focused commits
-- Please avoid mixing unrelated changes in a single commit
-- Commit at regular points to revert changes easily if needed
-
-### Write clear commit messages
-- Limit subject line to 50 characters
-- Provide more detailed explainations in the commit body (if required)
-- Use the imperative mood in the subject line (e.g. 'add' instead of 'added')
-
-```
-$ ~ git commit
-```
-
-```
-[Type]: [Short Subject]
----[Blank Line]---
-[Body, Limit to 72 Characters]
-```
-- Types: feat, fix, docs, style, refactor, test, chore, ci, perf
- - See [here](https://eagerworks.com/blog/conventional-commits) for more information
-
-## Branches
-
-### Naming Conventions
-
-- Use lowercase with hyphens
-- Include type and change with small description
-
-```
-[type]/[brief-description] :: e.g. feature/api
-```
-### Base Branch
-
-- Branch from `develop` for features and non-urgent fixes
-- Branch off from `main` for urgent changes (project deadline) - this should be rarely used
-
-### Keep branches updated
-
-- Regularly merge and also delete branches when stale
-
-## PRs
-
-1. Create a pull request for each feature or fix (link to related issues)
-2. Write a clear description which...
- 1. Summarises the changes
- 2. Explains the reasoning behind the changes
- 3. Lists any areas of concerns (i.e. breaking changes)
-3. Keep PRs focused - split changes into multiple PRs if needed
-4. Assign someone to review
-5. Merge ONLY after team approval - resolve conflicts & ensure CI checks pass
-6. Use [squash and merge](https://learn.microsoft.com/en-us/azure/devops/repos/git/merging-with-squash?view=azure-devops) when needed to keep main branch history clean \ No newline at end of file
git.ajschof.me — hosted by ajschofield — powered by cgit