Development - PelletierConstructionGroup/Pelletier-construction-group-nestjs GitHub Wiki

Coding Style

...coming soon!

Commit Messages

Read about how to make good commit messages from The Odin Project here and freecodecamp.org here.

If you're in a hurry, here are some guidelines from freecodecamp.org:

  • Capitalization and Punctuation: Capitalize the first word and do not end in punctuation. If using Conventional Commits, remember to use all lowercase.
  • Mood: Use imperative mood in the subject line. Example – Add fix for dark mode toggle state. Imperative mood gives the tone you are giving an order or request.
  • Type of Commit: Specify the type of commit. It is recommended and can be even more beneficial to have a consistent set of words to describe your changes. Example: Bugfix, Update, Refactor, Bump, and so on. See the section on Conventional Commits below for additional information.
  • Length: The first line should ideally be no longer than 50 characters, and the body should be restricted to 72 characters.
  • Content: Be direct, try to eliminate filler words and phrases in these sentences (examples: though, maybe, I think, kind of). Think like a journalist.\

Examples of good commit messages:

5ba3db6 Bugfix failing CompositePropertySourceTests
84564a0 Refactor @PropertySource early parsing logic
e142fd1 Add tests for ImportSelector meta-data
887815f Update docbook dependency and generate epub
ac8326d Polish mockito usage\

Examples of commit messages that need work:

e5f4b49 Re-adding ConfigurationPostProcessorTests after its brief removal in r814. @Ignore-ing the testCglibClassesAreLoadedJustInTimeForEnhancement() method as it turns out this was one of the culprits in the recent build breakage. The classloader hacking causes subtle downstream effects, breaking unrelated tests. The test method is still useful, but should only be run on a manual basis to ensure CGLIB is not prematurely classloaded, and should not be run as part of the automated build.
2db0f12 fixed two build-breaking issues: + reverted ClassMetadataReadingVisitor to revision 794 + eliminated ConfigurationPostProcessorTests until further investigation determines why it causes downstream tests to fail (such as the seemingly unrelated ClassPathXmlApplicationContextTests)
147709f Tweaks to package-info.java files
22b25e0 Consolidated Util and MutableAnnotationUtils classes into existing AsmUtils
7f96f57 polishing\

Git Branch Naming Convention

  • <category>-<issue id>-<brief name>-<part #>
  • feature-4-event-processing-01

Category

  • feature: new feature
  • bug : Code changes linked to a known issue
  • refactor: Code refactoring
  • experiment: Any new feature or idea that is not part of a release or a sprint. A branch for playing around.
  • documentation: for writing documentation
  • chore: for everything else (formatting, adding tests, cleaning useless code etc.)

Issue ID

Each Github issue has its associated id (ex. 1, 2, 3)

⚠️ **GitHub.com Fallback** ⚠️