All PRs will be verified against linting scripts to ensure styling consistency. For a faster feedback cycle, we recommend configuring git hooks.
Run the following to enable git hooks for this repository.
git config core.hooksPath .githooksSo we can attribute changes to the people involved we like to have signed commits
git config user.name "John Doe"
git config user.email [email protected]
# Or to configure globally for all repositories
git config --global user.name "John Doe"
git config --global user.email [email protected]Then use the -s or --signoff flag when committing.
SaanSoft.CorrelationId uses the en-GB dictionary for spell checking.
The dictionary.dic file at the root level of the repository contains project specific words.
Add the Code Spell Checker plugin and enable it.
The .cspell.json file in the root directory is configured to use and add any unknown words to the dictionary.
The en-GB dictionary comes packaged with the plugin, so no further setup is required.
Open the project then go to:
Settings>Editor>Spelling- Check
Use single dictionary for saving wordsand selectapplication-level - Under
Custom dictionaries (plain text word lists, hunspell)- Click the
+button - In the root directory of the repository, select
dictionary.dic - Save the changes
- Click the
Read more here
A consistent coding style is included via EditorConfig with the file .editorconfig at the root of the repo. Depending on your editor of choice, it will either support it out of the box or you can download a plugin for the config to be applied.