🛠️ 📚💡 This is a detailed and carefully made template for your GitHub projects. It's based on the wide knowledge and practical experience of the engineering community within NHS England. The template includes helpful suggestions, standards and practices - it's something you should consider using for all your repositories.
MIT License
30
stars
12
forks
source link
Update diagrams section and add Mermaids example #165
Small update to the README with suggestions for diagram options that keep the source under version control. I.e. drawio which is already used in the examples, but also mermaids. Also provide a basic mermaids example.
Context
Updates guidance on diagram tooling.
Type of changes
[ ] Refactoring (non-breaking change)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would change existing functionality)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] This PR is a result of pair or mob programming
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.
[ ] I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.
Description
Small update to the README with suggestions for diagram options that keep the source under version control. I.e.
drawiowhich is already used in the examples, but alsomermaids. Also provide a basicmermaidsexample.Context
Updates guidance on diagram tooling.
Type of changes
Checklist
Sensitive Information Declaration
To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.