Wittgenstein Explorer

Contributing to Witt App

Help us improve the Wittgenstein Interpretation Explorer by contributing to the project. We welcome contributions of all kinds, from code to documentation.

Ways to Contribute

🐛 Report Bugs

Found a bug? Open an issue on GitHub with:

  • Clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

💡 Suggest Features

Have an idea for improvement? Create a feature request with:

  • Clear description of the feature
  • Use cases and benefits
  • Potential implementation approach
  • Impact on existing functionality

📝 Improve Documentation

Help make our docs better by:

  • Fixing typos and errors
  • Adding missing information
  • Clarifying confusing sections
  • Adding examples and use cases

💻 Submit Code

Want to write code? Here's how:

  • Fork the repository
  • Create a feature branch
  • Write clean, documented code
  • Submit a pull request

Development Setup

# Clone the repository
git clone https://github.com/rogerHuntGauntlet/witt-app.git
cd witt-app

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env.local
# Edit .env.local with your API keys

# Start development server
npm run dev

Project Structure

witt-app/
├── documentation/    # Project documentation
├── public/          # Static assets
├── src/
│   ├── components/  # React components
│   ├── lib/         # Utility functions
│   ├── pages/       # Next.js pages
│   ├── scripts/     # Utility scripts
│   └── styles/      # CSS styles
└── ...

Guidelines

Code Style

  • Use TypeScript for type safety
  • Follow the existing code style
  • Write clear, documented code
  • Include tests for new features

Commit Messages

Follow conventional commits format:

  • feat: add new feature
  • fix: resolve bug
  • docs: update documentation
  • style: format code

Pull Requests

  • Create focused, single-purpose PRs
  • Include clear descriptions
  • Reference related issues
  • Update documentation as needed

Ready to Contribute?

Check out our GitHub repository to get started. Make sure to read our Code of Conduct andContributing Guidelines before making your contribution.