Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.39 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 2.39 KB
Raw

Contributing to ML Model Explorer

Thank you for considering contributing to ML Model Explorer! Contributions from the community help us improve the project and make it more useful for everyone. Please read through this document to understand how to contribute and what to expect when working on this project.

How to Contribute

  1. Fork the Repository:

    • Fork the repository to your GitHub account.

  2. Create a New Branch:

    • Create a new branch for your changes (git checkout -b feature/your-feature).

  3. Make Changes and Commit:

    • Make your modifications and additions.
    • Write clear and concise commit messages that describe the changes you've made.

  4. Push Your Changes:

    • Push your changes to your branch (git push origin feature/your-feature).

  5. Submit a Pull Request:

    • Open a pull request in the main repository.
    • Provide a descriptive title and detailed description of your changes.
    • Reference any related issues or discussions in your pull request.

Contribution Guidelines

  • Be Respectful:

  • Code Standards:

    • Follow coding standards and best practices.
    • Ensure your code is well-documented and tested.

  • Commit Messages:

    • Use clear and descriptive commit messages that explain what you've changed.

  • Review Process:

    • Your pull request will be reviewed by maintainers.
    • Be prepared to make changes if requested by the reviewers.
    • Engage in respectful discussion to resolve any issues.

  • Bug Reports and Feature Requests:

    • When submitting a bug report or feature request, provide as much detail as possible.
    • Use clear titles and descriptions to help us understand the issue or request.

Getting Started

  • If you're new to the project, review the README for an overview and usage instructions.
  • Familiarize yourself with the project structure and codebase.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0. Please review the LICENSE file for more information.

Questions?

If you have any questions, feel free to open an issue in the repository or reach out directly.

Happy contributing!