Skip to content

Latest commit

 

History

History
146 lines (102 loc) · 3.77 KB

CONTRIBUTING.md

File metadata and controls

146 lines (102 loc) · 3.77 KB

Contributing to TechBlitz

First off, thank you for considering contributing to TechBlitz! It's people like you that make TechBlitz such a great tool for developers worldwide.

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone [email protected]/{username}/TechBlitz.git
  3. Create your feature branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Commit your changes: git commit -m 'Add some feature'
  6. Push to the branch: git push origin feature/your-feature-name
  7. Submit a pull request

Prerequisites

  • Node.js (version 18 or higher)
  • npm or yarn
  • Git

How Can I Contribute?

There are many ways you can contribute to TechBlitz:

Reporting Bugs

  • Use the GitHub Issues section to report bugs
  • Check existing issues before creating a new one
  • Include detailed information about how to reproduce the bug
  • Use the bug report template when creating a new issue

Suggesting Features

  • Use the GitHub Issues section with the enhancement label
  • Provide clear use cases for the feature
  • Explain the benefit to the wider TechBlitz community
  • Use the feature request template when creating a new issue

Contributing Code

  1. Pick an issue to work on
  2. Comment on the issue to let others know you're working on it
  3. Follow our coding standards and styleguides
  4. Update documentation as needed

Writing Documentation

  • Help improve our docs
  • Add examples and use cases
  • Fix typos and clarify language
  • Add missing information

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Add tests for any new features
  3. Update documentation accordingly
  4. Follow the PR template
  5. Wait for review from maintainers

PR Review Process

  1. At least one maintainer must approve
  2. All CI checks must pass
  3. Documentation must be updated
  4. Tests must be included
  5. Code must follow style guidelines

Development Process

Setting Up Your Development Environment

# Install dependencies
npm install

# Start development server
npm run dev

# Check types
npm run types

# Run linter
npm run lint

Branch Naming Convention

  • feature/ - for new features
  • bug/ - for bug fixes
  • docs/ - for documentation
  • test/ - for test additions or improvements
  • chore/ - for code refactoring & general code maintaince

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

  • Use TypeScript for new code
  • Follow the existing code style
  • Use ESLint and Prettier
  • Add JSDoc comments for functions and complex code
  • Keep functions small and focused

Documentation Styleguide

  • Use Markdown for documentation
  • Keep language clear and concise
  • Add examples where helpful
  • Keep headings hierarchical
  • Update table of contents when needed

Community

  • Follow us on X
  • Star us on GitHub!

Questions?

Don't hesitate to ask questions! You can reach us at:

Thank you for contributing to TechBlitz! 🚀