Skip to content

Docs: Add Export Strategy and Workflow Guidelines #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
Zaiidmo merged 3 commits into from
Jan 30, 2026
Merged

Docs: Add Export Strategy and Workflow Guidelines #9

Zaiidmo merged 3 commits into from
Jan 30, 2026

Conversation

@RedaChannaCiscode
Copy link
Contributor

@RedaChannaCiscode RedaChannaCiscode commented Jan 30, 2026

Export Strategy e Workflow - Auth-Kit-UI

Definizione della strategia di export e workflow per il modulo UI authentication.

Cambiamenti

1. Task Documentation Structure

  • Cartella \docs/tasks/active/\ con README
  • Convenzione prefisso UI-MODULE- per task
  • Focus su accessibility, responsive, component API

2. Export Strategy Definition

  • Cosa esportare:
  • Components (LoginForm, RegisterForm, etc.)
  • Hooks (useAuth, useProtectedRoute)
  • Types (TypeScript interfaces)
  • Cosa NON esportare:
  • Internal utilities
  • Private helpers
  • Rationale documentato:
  • Components = public UI API
  • Hooks = public logic API
  • Types = TypeScript contracts
  • Internal utils = implementation details

3. Workflow Guidelines

  • Task naming: \ eature/UI-MODULE-123-description\
  • Task documentation con:
  • Component changes
  • Accessibility considerations
  • Breaking changes in component API
  • Workflow simple vs complex changes

Commits (2)

  1. docs: create task documentation structure for UI module
  2. docs: add export strategy and workflow guidelines

Checklist

  • Export strategy definita
  • Workflow UI-MODULE- prefix
  • Task structure documentata
  • Breaking changes handling
  • Nessun codice modificato (solo docs)

Prossimi Passi

  1. Verificare exports in \src/index.ts\ corrispondano
  2. Audit accessibility componenti esistenti
  3. Usare workflow per nuovi componenti

@RedaChannaCiscode
docs: add copilot development instructions
9780e3f 
- Add React component library development guidelines
- Include accessibility and i18n requirements
- Document component patterns and testing standards
- Add release checklist
@RedaChannaCiscode
docs: create task documentation structure for UI module
14de131 
- Add active tasks folder with UI-MODULE- prefix
- Establish workflow for UI component tasks
- Add UI-specific documentation focus (accessibility, responsive)
@RedaChannaCiscode
docs: add export strategy and workflow guidelines
548fffb 
- Define export strategy (Components + Hooks + Types only)
- Document rationale for public API exports
- Add workflow with UI-MODULE- prefix convention
- Include breaking changes handling for component APIs
- Add task documentation structure examples
@RedaChannaCiscode RedaChannaCiscode requested review from a team and Copilot January 30, 2026 16:12
Copilot AI reviewed Jan 30, 2026
View reviewed changes
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR establishes comprehensive documentation for the Auth Kit UI module's export strategy and development workflow, without modifying any code. It defines clear guidelines for task management, component exports, and development practices for the React authentication component library.

Changes:

  • Created task documentation structure with UI-MODULE prefix convention
  • Defined export strategy specifying what should and shouldn't be exported from the module
  • Established workflow guidelines for branch naming, task documentation, and release processes

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/tasks/active/README.md Introduces task documentation structure with UI-specific focus areas including accessibility and component API changes
.github/copilot-instructions.md Comprehensive development guidelines covering module structure, export strategy, workflow, testing standards, and accessibility requirements

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Zaiidmo Zaiidmo merged commit 2670111 into master Jan 30, 2026
@Zaiidmo Zaiidmo deleted the docs/copilot-instructions branch January 30, 2026 16:14
Zaiidmo added a commit that referenced this pull request Feb 2, 2026
@a-elkhiraooui-ciscode @Zaiidmo
@RedaChannaCiscode @Ciscode-Admin
Fix/verify email UI (#14)
4b80af4 
* parents translate, components receive plain strings

* 1.0.3

* tested in local, bug fixed

* 1.0.4

* 1.0.5

* forgot and reset password done

* 1.0.6

* Feat/forgot password (#8)

* parents translate, components receive plain strings

* 1.0.3

* tested in local, bug fixed

* 1.0.4

* forgot and reset password done

* 1.0.6

* Docs: Add Export Strategy and Workflow Guidelines (#9)

* docs: add copilot development instructions

- Add React component library development guidelines
- Include accessibility and i18n requirements
- Document component patterns and testing standards
- Add release checklist

* docs: create task documentation structure for UI module

- Add active tasks folder with UI-MODULE- prefix
- Establish workflow for UI component tasks
- Add UI-specific documentation focus (accessibility, responsive)

* docs: add export strategy and workflow guidelines

- Define export strategy (Components + Hooks + Types only)
- Document rationale for public API exports
- Add workflow with UI-MODULE- prefix convention
- Include breaking changes handling for component APIs
- Add task documentation structure examples

* 1.0.7

* Updated workflows  (#10)

* ops: updated release pipeline to run only on version changes, and created ci workflow

* 1.0.8

* docs(workflow): add Git Flow and npm version requirements (#11)

- Add Git Flow branching strategy (develop/master)
- Document npm version command before push
- Add prepublishOnly hook recommendation
- Update workflow with proper branch management
- Clear warnings about PR targeting

Co-authored-by: Reda Channa <r.channa@ciscod.com>
Co-authored-by: Zaiid Moumni <141942826+Zaiidmo@users.noreply.github.com>

* docs: added different documentations

* 1.0.9

* ops: updated publishing trigger

* verify email page done

* merged

* 1.0.10

---------

Co-authored-by: Zaiidmo <zaiidmoumnii@gmail.com>
Co-authored-by: RedaChannaCiscode <r.channa@ciscod.com>
Co-authored-by: Zaiid Moumni <141942826+Zaiidmo@users.noreply.github.com>
Co-authored-by: Ciscode-Admin <info@ciscod.com>
Zaiidmo added a commit that referenced this pull request Feb 2, 2026
@a-elkhiraooui-ciscode @Zaiidmo
@RedaChannaCiscode @Ciscode-Admin
Fix/microsoft bug (#15)
45d0589 
* parents translate, components receive plain strings

* 1.0.3

* tested in local, bug fixed

* 1.0.4

* 1.0.5

* forgot and reset password done

* 1.0.6

* Feat/forgot password (#8)

* parents translate, components receive plain strings

* 1.0.3

* tested in local, bug fixed

* 1.0.4

* forgot and reset password done

* 1.0.6

* Docs: Add Export Strategy and Workflow Guidelines (#9)

* docs: add copilot development instructions

- Add React component library development guidelines
- Include accessibility and i18n requirements
- Document component patterns and testing standards
- Add release checklist

* docs: create task documentation structure for UI module

- Add active tasks folder with UI-MODULE- prefix
- Establish workflow for UI component tasks
- Add UI-specific documentation focus (accessibility, responsive)

* docs: add export strategy and workflow guidelines

- Define export strategy (Components + Hooks + Types only)
- Document rationale for public API exports
- Add workflow with UI-MODULE- prefix convention
- Include breaking changes handling for component APIs
- Add task documentation structure examples

* 1.0.7

* Updated workflows  (#10)

* ops: updated release pipeline to run only on version changes, and created ci workflow

* 1.0.8

* docs(workflow): add Git Flow and npm version requirements (#11)

- Add Git Flow branching strategy (develop/master)
- Document npm version command before push
- Add prepublishOnly hook recommendation
- Update workflow with proper branch management
- Clear warnings about PR targeting

Co-authored-by: Reda Channa <r.channa@ciscod.com>
Co-authored-by: Zaiid Moumni <141942826+Zaiidmo@users.noreply.github.com>

* docs: added different documentations

* 1.0.9

* ops: updated publishing trigger

* verify email page done

* merged

* 1.0.10

* updated endpoints

---------

Co-authored-by: Zaiidmo <zaiidmoumnii@gmail.com>
Co-authored-by: RedaChannaCiscode <r.channa@ciscod.com>
Co-authored-by: Zaiid Moumni <141942826+Zaiidmo@users.noreply.github.com>
Co-authored-by: Ciscode-Admin <info@ciscod.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@Zaiidmo Zaiidmo Zaiidmo approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@RedaChannaCiscode @Zaiidmo