Contributing to React NIS2 Guard

December 26, 2025 · View on GitHub

Thank you for your interest in contributing to @nis2shield/react-guard! 🛡️

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/react-guard.git
  3. Install dependencies: npm install
  4. Create a branch: git checkout -b feature/your-feature-name

Development

# Run the development server
npm run dev

# Run tests
npm test

# Build the library
npm run build

# Type check
npx tsc --noEmit

Pull Request Guidelines

  1. One feature per PR - Keep changes focused
  2. Write tests - All new features should include tests
  3. Update documentation - Update README if adding user-facing features
  4. Follow TypeScript - Ensure all code is properly typed
  5. Run checks - Ensure npm test and npm run build pass

Commit Messages

Use conventional commits:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • test: Adding or updating tests
  • refactor: Code refactoring

Code Style

  • Use TypeScript for all new code
  • Follow existing patterns in the codebase
  • Use functional components and hooks
  • Document public APIs with JSDoc comments

Reporting Issues

When reporting bugs, please include:

  • Browser and version
  • React version
  • Steps to reproduce
  • Expected vs actual behavior

Questions?

Open an issue with the question label or contact the maintainers.

Part of the NIS2 Shield ecosystem.