Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 2.69 KB
Raw

Contributing to ML Spec

Thank you for your interest in contributing to ML Spec! We welcome contributions from the community to help improve and advance the project. This document outlines the guidelines and best practices for contributing to ML Spec.

Code of Conduct

We have adopted the Contributor Covenant as our Code of Conduct. By participating in this project, you agree to abide by its terms. Please read the CODE_OF_CONDUCT.md file for more information.

Ways to Contribute

There are several ways you can contribute to ML Spec:

  • Reporting bugs and issues
  • Suggesting enhancements and new features
  • Improving documentation
  • Submitting pull requests with bug fixes or new features
  • Providing feedback and suggestions for improvement

Getting Started

  1. Fork the ML Spec repository on GitHub.
  2. Clone your forked repository to your local machine.
  3. Create a new branch for your contribution.
  4. Make your changes and commit them with descriptive messages.
  5. Push your changes to your forked repository.
  6. Submit a pull request to the main ML Spec repository.

Pull Request Guidelines

When submitting a pull request, please ensure the following:

  • Provide a clear and descriptive title.
  • Include a detailed description of the changes made and the problem they solve.
  • Reference any relevant issues or pull requests.
  • Ensure your code follows the project's coding conventions and style guide.
  • Include tests for any new functionality or bug fixes.
  • Update the documentation if necessary.

Issue Reporting

If you encounter a bug or have a feature request, please submit an issue on the GitHub issue tracker. When reporting an issue, please provide the following information:

  • A clear and descriptive title.
  • A detailed description of the issue or feature request.
  • Steps to reproduce the issue (if applicable).
  • Any relevant error messages or logs.
  • Your operating system and version.
  • Any other relevant information.

Communication

If you have any questions, suggestions, or need clarification, you can reach out to the maintainers and the community through the following channels:

  • GitHub Issues: For bug reports, feature requests, and general discussions related to the project.
  • ML Spec Mailing List: For general discussions, announcements, and community engagement.
  • ML Spec Slack Channel: For real-time communication and collaboration with the community.

License

By contributing to ML Spec, you agree that your contributions will be licensed under the Apache License 2.0.

Thank you for your contributions and helping to make ML Spec better!