Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (36 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

51 lines (36 loc) · 1.31 KB

Skill Mapper - Contributing Guide

Thank you for considering contributing to Skill Mapper! This document provides guidelines and instructions for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/skill-mapper.git
  3. Create a branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes: npm test
  6. Commit your changes: git commit -m 'Add some feature'
  7. Push to your branch: git push origin feature/your-feature-name
  8. Open a Pull Request

Development Setup

npm install
npm run dev

Code Style

  • We use Prettier for code formatting
  • Run npm run lint before committing
  • Follow TypeScript best practices
  • Write meaningful commit messages

Testing

  • Write tests for new features
  • Ensure all tests pass: npm test
  • Run tests with UI: npm run test:ui
  • Check code coverage: npm run test:coverage

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update any documentation that is affected by your changes
  3. The PR will be merged once you have approval from a maintainer

Code of Conduct

  • Be respectful and inclusive
  • Provide constructive feedback
  • Focus on what is best for the community

Questions?

Open an issue for any questions or concerns!