Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 2.89 KB

Contributing to Jupiter TypeScript Examples

🚀 Thank you for your interest in contributing to the Jupiter TypeScript Examples repository!

This document outlines guidelines for contributing to our collection of TypeScript examples for Jupiter Exchange APIs. These are meant to be helpful suggestions rather than strict rules - use your best judgment and feel free to propose changes to these guidelines.

Table of Contents

Ways to Contribute

Bug Reports

Before submitting a bug report:

  1. Search existing issues in the Issues tab to avoid duplicates

  2. If the issue hasn't been reported, create a new issue with:

    • A clear, descriptive title
    • Detailed steps to reproduce the bug
    • Expected vs actual behavior
    • Code samples or error messages
    • Your environment details (OS, Node.js version, etc.)

Feature Requests

Have an idea for a new example or improvement?

  1. First, review existing issues to see if someone else has suggested something similar

  2. If it's a new idea, open an issue that includes:

    • A clear description of the example or feature
    • The use case it addresses
    • Potential implementation approaches
    • Any relevant examples or references

Pull Requests

Ready to contribute code? Here's how:

  1. Fork & Clone: Fork the repository and create a feature branch from main

  2. Development:

    • Create or modify examples following our development guidelines
    • Ensure your example is well-documented with comments
    • Test thoroughly to make sure it works as expected
    • Keep changes focused on a single example or feature

  3. Submit:

    • Write clear, descriptive commit messages
    • Push to your fork and submit a pull request
    • Include a detailed description of what your example demonstrates
    • Link related issues

  4. Review Process:

    • Maintainers will review your PR as soon as possible
    • Address any requested changes promptly
    • Be patient and responsive during the review process

Development Guidelines

To maintain code quality and consistency:

  • Write clean, typed code using TypeScript
  • Include clear comments explaining what each part of your example does
  • Use meaningful variable and function names
  • Structure your example in a way that's easy to understand
  • Follow Jupiter API best practices
  • Include a README.md for complex examples
  • Ensure compatibility with the latest Jupiter SDK version
  • Follow existing code style and formatting conventions
  • Add appropriate error handling to make examples robust