Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
171 lines (124 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

171 lines (124 loc) · 3.77 KB

Contributing to NextSight

Thank you for your interest in contributing to NextSight! This document provides guidelines and instructions for contributing.

Code of Conduct

By participating in this project, you agree to maintain a respectful and inclusive environment for everyone.

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue with:
    • Clear, descriptive title
    • Steps to reproduce
    • Expected vs actual behavior
    • Environment details (OS, Docker version, K8s version)

Suggesting Features

  1. Check existing issues for similar suggestions
  2. Create a new issue with the enhancement label
  3. Describe the feature and its use case

Pull Requests

  1. Fork the repository
  2. Create a feature branch from develop: 
    git checkout -b feature/your-feature-name
  3. Make your changes following our coding standards
  4. Write/update tests if applicable
  5. Update documentation if needed
  6. Commit with clear, descriptive messages
  7. Push and create a Pull Request to develop

Development Setup

Prerequisites

  • Python 3.11+
  • Node.js 18+
  • Docker & Docker Compose
  • kubectl configured with a cluster

Local Development

# Clone the repository
git clone https://github.com/gauravtayade11/nexops.git
cd NextSight

# Using Docker Compose (recommended)
make dev

# Or manually:
# Backend
cd backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload

# Frontend (new terminal)
cd frontend
npm install
npm run dev

Coding Standards

Python (Backend)

  • Follow PEP 8 style guide
  • Use type hints
  • Write docstrings for public functions
  • Keep functions focused and small

TypeScript (Frontend)

  • Use TypeScript strict mode
  • Follow ESLint configuration
  • Use functional components with hooks
  • Keep components focused and reusable

Git Commit Messages

  • Use present tense ("Add feature" not "Added feature")
  • Use imperative mood ("Move cursor" not "Moves cursor")
  • Keep first line under 72 characters
  • Reference issues when applicable

Project Structure

NextSight/
├── backend/           # FastAPI backend
│   ├── app/
│   │   ├── api/       # API routes
│   │   ├── core/      # Configuration
│   │   ├── schemas/   # Pydantic models
│   │   └── services/  # Business logic
│   └── tests/
├── frontend/          # React frontend
│   ├── src/
│   │   ├── components/
│   │   ├── services/
│   │   └── types/
│   └── tests/
└── k8s/              # Kubernetes manifests

Branch Strategy

  • main - Production-ready code
  • develop - Integration branch for features
  • feature/* - New features
  • bugfix/* - Bug fixes
  • hotfix/* - Urgent fixes for production
  • release/* - Release preparation

Commit Message Format

We follow Conventional Commits:

<type>(<scope>): <subject>

<body>

<footer>

Types: feat, fix, docs, style, refactor, perf, test, chore

Example:

feat(security): add AI-powered remediation for RBAC issues

- Integrate Google Gemini for intelligent analysis
- Add step-by-step remediation commands

Closes #123

Testing

# Backend tests
cd backend && pytest --cov=app

# Frontend linting
cd frontend && npm run lint

# Type checking
cd frontend && npx tsc --noEmit

Security

For security vulnerabilities, please see SECURITY.md.

Questions?

Thank you for contributing!