Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.34 KB

Contribution.md

File metadata and controls

27 lines (18 loc) · 1.34 KB

Contribution Guide

Thank you for your interest in contributing to the Fireworks repository! We welcome contributions from everyone, whether you want to fix a bug, add new examples, or improve our documentation.

How to Contribute

  1. Fork the repository: Start by forking the repo to your GitHub account.
  2. Create a branch: Use a feature branch for your work. 
    git checkout -b feature/your-feature
  3. Make your changes: Implement your changes or add new examples.
  4. Test your work: Ensure that your changes work as expected.
  5. Submit a pull request: Open a pull request, describe the changes, and link to any relevant issues.

Contribution Guidelines

  • Bug Fixes: Submit fixes for issues via a pull request. Be sure to reference the relevant issue number in your PR.
  • New Examples: Follow the structure outlined in the repo for adding new reference, learning, or showcase examples.
  • Documentation: If you spot any errors or can help clarify the documentation, feel free to contribute.

Larger Contributions

If you're planning a larger or more complex change, please open a new issue first to discuss your proposal. This will help us ensure your work aligns with the repo's goals and avoid redundant efforts.

We truly appreciate your contributions and collaboration in improving this community resource!