Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
75 lines (55 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

75 lines (55 loc) · 1.89 KB

Contributing to Tech Leadership

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

Code of Conduct

Please read and follow our Code of Conduct.

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in the Issues section
  2. If not, create a new issue with a clear title and description
  3. Include steps to reproduce, expected behavior, and actual behavior
  4. Add screenshots if applicable

Suggesting Features

  1. Check if the feature has already been suggested in the Issues section
  2. If not, create a new issue with a clear title and description
  3. Explain why this feature would be useful
  4. Include any relevant examples or mockups

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Write or update tests as needed
  5. Update documentation if necessary
  6. Submit a pull request

Development Setup

  1. Clone the repository:
git clone https://github.com/carlsendk/tech-leadership.git
cd tech-leadership
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

Code Style

  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Keep functions small and focused
  • Write tests for new features

Commit Messages

  • Use clear and descriptive commit messages
  • Reference issues and pull requests when applicable
  • Follow the conventional commits format:
    • feat: A new feature
    • fix: A bug fix
    • docs: Documentation changes
    • style: Code style changes
    • refactor: Code refactoring
    • test: Adding or updating tests
    • chore: Maintenance tasks

License

By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.
⚡