Keep the site stable, modular and scalable without breaking the framework.
- Edit content, not structure.
- ✅ Safe: change text, images, links, colors in
src/assets/css/andsrc/assets/img/. - ✅ Safe: add new pages in
src/html/nav/, add blog pages tosrc/blog/{category}. ⚠️ Be careful: files insrc/_layouts/,src/_includes/, and_config.yml.
- ✅ Safe: change text, images, links, colors in
- One change at a time. Make a small change, test, then move on.
- Never delete files unless you are sure they are unused.
- Keep JS widgets modular. Put new JS in
src/assets/js/and import it from a page. - Public repo: Do not place any sensitive information like API secrets in this workspace.
- Keep coverage at 100%, add unit tests whenever it drops below this value.
- Every new function or change to a function/stateflow must include unit tests and coverage.
- Add or update tests in
src/test/and ensure coverage includes the new behavior.
- Run formatting and linting before committing:
npm run formatnpm run lint
- Review build warnings and address them before considering the work complete.
- Do not rename
src/_layouts/,src/_includes/, orsrc/assets/js/files without updating all references. - Do not change Jekyll front matter keys (
nav_label,nav_order,layout) unless you know the impact. - Do not touch
/config/*unless instructed or verified by user.