Skip to content

Latest commit

 

History

History
59 lines (35 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

59 lines (35 loc) · 2.65 KB
Raw

Contributing to Modular Diffusion

Thank you for your interest in contributing to Modular Diffusion! We welcome your support and contributions to help us improve and expand this framework. Whether you want to fix a bug, enhance an existing feature, or introduce a new prebuilt module, your contributions are valuable to us.

How to Contribute

Reporting Issues

If you encounter a bug, have a suggestion, or find a typo in the documentation, please feel free to open an issue on our GitHub repository. When reporting an issue, please provide as much detail as possible, including:

  • A clear and concise description of the issue or enhancement request.
  • Steps to reproduce the issue, if applicable.
  • Information about your environment, such as Python version, PyTorch version, and any other relevant details.

Adding New Features and Modules

If you want to contribute a new feature to Modular Diffusion, we recommend starting by opening an issue to discuss your idea with the maintainers. This way, we can ensure that the module aligns with the project's goals and design. If we give you the green light, you're free to submit a pull request.

Pull Requests

We encourage you to submit pull requests to address issues or contribute new features. Here's how to do it:

  1. Fork the Modular Diffusion GitHub repository to your own GitHub account.

  2. Clone your forked repository to your local machine:

    git clone https://github.com/your-username/modular-diffusion.git

  3. Create a new branch for your changes:

    git checkout -b your-feature-name

  4. Make your changes, attempting to follow the same code style of the project.

  5. Commit your changes with clear and descriptive commit messages:

    git commit -m "Add new feature"

  6. Push your changes to your GitHub repository:

    git push origin your-feature-name

  7. Open a pull request on the Modular Diffusion GitHub repository from your branch to the main branch. Please provide a detailed description of your changes in the pull request.

  8. Your pull request will be reviewed, and any necessary feedback or changes will be discussed.

  9. Once your pull request is approved, it will be merged into the main codebase, and your contribution will be acknowledged.

License

By contributing to Modular Diffusion, you agree that your contributions will be licensed under the MIT License. This ensures that your contributions can be freely used, modified, and distributed by others.