Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (48 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

68 lines (48 loc) · 1.35 KB
Raw

Contributing to IndexSwapy

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

Code of Conduct

Please be respectful and considerate of others when contributing to this project.

How to Contribute

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Submit a pull request

Pull Request Guidelines

  • Ensure your code follows the existing style
  • Add tests for new features
  • Update documentation as needed
  • Keep pull requests focused and small
  • Reference any related issues

Development Setup

  1. Clone the repository:
git clone https://github.com/59n/indexswapy.git
cd indexswapy
  1. Install dependencies:
npm install
  1. Start the development server:
npm start
  1. Run tests:
npm test

Code Style

  • Use consistent indentation (2 spaces)
  • Follow JavaScript best practices
  • Add comments for complex logic
  • Keep functions small and focused

Testing

  • Write tests for new features
  • Ensure all tests pass before submitting PR
  • Update tests when modifying existing features

Documentation

  • Update README.md for significant changes
  • Add comments for complex code
  • Document new features

Questions?

Feel free to open an issue if you have any questions about contributing!