How to Contribute

Thank you for considering contributing to PolyMarks! 🎯

How to Contribute

1. Fork the Repository

Click the "Fork" button at the top right of this page.

2. Clone Your Fork

git clone https://github.com/YOUR_USERNAME/polymarks.git
cd polymarks

3. Create a Branch

git checkout -b feature/your-feature-name

4. Make Your Changes

  • Follow the existing code style

  • Add comments for complex logic

  • Test your changes locally

5. Commit Your Changes

Commit Message Format:

  • feat: - New feature

  • fix: - Bug fix

  • docs: - Documentation changes

  • style: - Code style changes (formatting, etc.)

  • refactor: - Code refactoring

  • test: - Adding tests

  • chore: - Maintenance tasks

6. Push to Your Fork

7. Open a Pull Request

Go to the original repository and click "New Pull Request"

Code Style

  • Use TypeScript for all new code

  • Follow existing naming conventions

  • Use functional components with hooks

  • Add JSDoc comments for complex functions

  • Keep components small and focused

Feature Requests

Have an idea? Open an issue with the enhancement label.

Bug Reports

Found a bug? Open an issue with:

  • Description of the bug

  • Steps to reproduce

  • Expected behavior

  • Screenshots (if applicable)

Questions?

Open a discussion or reach out on Twitter @polymarksBSCarrow-up-right

Thank you! 🙏

Last updated