Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 1.95 KB

CONTRIBUTING.md

File metadata and controls

26 lines (16 loc) · 1.95 KB

Contributing to fmperf

Welcome! Become a contributor and join us in developing fmperf as an essential tool to enhance the adoption of generative AI.

Before you get started

Please make sure to read and observe our Code of Conduct. fmperf is a community-driven project that thrives on the active participation and collaboration of its members. We strive to promote a healthy, friendly, and productive environment where everyone can contribute effectivel

Getting started

  • clone fmperf on your local computer
  • follow the guidelines detailed in the README to install fmperf from source
  • Make your changes on your local repository, preferably on a new branch.
  • Submit a Pull Request.
  • If you need help or have suggestions please open an issue directly on fmperf repo.

Find something to work on

We are here to support your contributions to fmperf, whether it's through code refactoring, developing new features, fixing critical bugs, or getting your work reviewed and merged.

If you have questions about fmperf and about ways to contribute, file an issue. Alternatively, if you are interested in resolving an issue, the maintainer can assign it to you. We are excited to collaborate with you.

Creating Pull Requests

When submitting a pull request, it will be checked by our Continuous Integration (CI) system to ensure code quality and functionality. To facilitate a smooth review process, contributors must adhere to clean code principles and use tools like linters (fmperf supports black) before committing their changes. This practice helps catch potential issues early, maintains code consistency, and enhances readability, making it easier for others to review and collaborate on the project. Ensuring your code passes linting and other automated checks will expedite the integration of your contributions into the main codebase.