Documentations for Open Access

.github/workflows/build.yml

@@ -6,14 +6,10 @@ on:
   push:
     branches:
       - main
-    paths-ignore:
-      - "**.md"
 
   pull_request:
     branches:
       - main
-    paths-ignore:
-      - "**.md"
 
 defaults:
   run:

CODE-OF-CONDUCT.md

@@ -0,0 +1,101 @@
+## CNCF Community Code of Conduct v1.3
+
+fmperf follows CNCF Code-of-Conduct.
+
+As contributors, maintainers, and participants in the CNCF community, and in the interest of fostering
+an open and welcoming community, we pledge to respect all people who participate or contribute
+through reporting issues, posting feature requests, updating documentation,
+submitting pull requests or patches, attending conferences or events, or engaging in other community or project activities.
+
+We are committed to making participation in the CNCF community a harassment-free experience for everyone, regardless of age, body size, caste, disability, ethnicity, level of experience, family status, gender, gender identity and expression, marital status, military or veteran status, nationality, personal appearance, race, religion, sexual orientation, socioeconomic status, tribe, or any other dimension of diversity.
+
+## Scope
+
+This code of conduct applies:
+* within project and community spaces,
+* in other spaces when an individual CNCF community participant's words or actions are directed at or are about a CNCF project, the CNCF community, or another CNCF community participant.
+
+## Our Standards
+
+The CNCF Community is open, inclusive and respectful. Every member of our community has the right to have their identity respected.
+
+Examples of behavior that contributes to a positive environment include but are not limited to:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+* Using welcoming and inclusive language
+
+
+Examples of unacceptable behavior include but are not limited to:
+
+* The use of sexualized language or imagery
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment in any form
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Violence, threatening violence, or encouraging others to engage in violent behavior
+* Stalking or following someone without their consent
+* Unwelcome physical contact
+* Unwelcome sexual or romantic attention or advances
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+The following behaviors are also prohibited:
+* Providing knowingly false or misleading information in connection with a Code of Conduct investigation or otherwise intentionally tampering with an investigation.
+* Retaliating against a person because they reported an incident or provided information about an incident as a witness.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct.
+By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect
+of managing a CNCF project.
+Project maintainers who do not follow or enforce the Code of Conduct may be temporarily or permanently removed from the project team.
+
+## Reporting
+
+For incidents occurring in the Kubernetes community, contact the [Kubernetes Code of Conduct Committee](https://git.k8s.io/community/committee-code-of-conduct) via <[email protected]>. You can expect a response within three business days.
+
+For other projects, or for incidents that are project-agnostic or impact multiple CNCF projects, please contact the [CNCF Code of Conduct Committee](https://www.cncf.io/conduct/committee/) via <[email protected]>.  Alternatively, you can contact any of the individual members of the [CNCF Code of Conduct Committee](https://www.cncf.io/conduct/committee/) to submit your report. For more detailed instructions on how to submit a report, including how to submit a report anonymously, please see our [Incident Resolution Procedures](https://github.com/cncf/foundation/blob/main/code-of-conduct/coc-incident-resolution-procedures.md). You can expect a response within three business days.
+
+For incidents occurring at CNCF event that is produced by the Linux Foundation, please contact <[email protected]>.
+
+## Enforcement
+
+Upon review and investigation of a reported incident, the CoC response team that has jurisdiction will determine what action is appropriate based on this Code of Conduct and its related documentation.
+
+For information about which Code of Conduct incidents are handled by project leadership, which incidents are handled by the CNCF Code of Conduct Committee, and which incidents are handled by the Linux Foundation (including its events team), see our [Jurisdiction Policy](https://github.com/cncf/foundation/blob/main/code-of-conduct/coc-committee-jurisdiction-policy.md).
+
+## Amendments
+
+Consistent with the CNCF Charter, any substantive changes to this Code of Conduct must be approved by the Technical Oversight Committee.
+
+## Acknowledgements
+
+This Code of Conduct is adapted from the Contributor Covenant
+(http://contributor-covenant.org), version 2.0 available at
+http://contributor-covenant.org/version/2/0/code_of_conduct/
+
+Other languages available:
+- [Arabic/العربية](code-of-conduct-languages/ar.md)
+- [Bengali/বাংলা](code-of-conduct-languages/bn.md)
+- [Bulgarian/Български](code-of-conduct-languages/bg.md)
+- [Chinese/中文](code-of-conduct-languages/zh.md)
+- [Czech/Česky](code-of-conduct-languages/cs.md)
+- [Farsi/فارسی](code-of-conduct-languages/fa.md)
+- [French/Français](code-of-conduct-languages/fr.md)
+- [German/Deutsch](code-of-conduct-languages/de.md)
+- [Hindi/हिन्दी](code-of-conduct-languages/hi.md)
+- [Indonesian/Bahasa Indonesia](code-of-conduct-languages/id.md)
+- [Italian/Italiano](code-of-conduct-languages/it.md)
+- [Japanese/日本語](code-of-conduct-languages/ja.md)
+- [Korean/한국어](code-of-conduct-languages/ko.md)
+- [Polish/Polski](code-of-conduct-languages/pl.md)
+- [Portuguese/Português](code-of-conduct-languages/pt.md)
+- [Russian/Русский](code-of-conduct-languages/ru.md)
+- [Spanish/Español](code-of-conduct-languages/es.md)
+- [Turkish/Türkçe](code-of-conduct-languages/tr.md)
+- [Ukrainian/Українська](code-of-conduct-languages/uk.md)
+- [Vietnamese/Tiếng Việt](code-of-conduct-languages/vi.md)

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# 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](/CODE-OF-CONDUCT.md).
+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](https://github.com/fmperf-project/fmperf.git) on your local computer
+- follow the guidelines detailed in the [README](/README.md) 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](https://github.com/fmperf-project/fmperf/issues/new). 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.

MAINTAINERS.md

@@ -0,0 +1,10 @@
+# fmperf Maintainers
+
+This is the current list of maintainers for the fmperf project.
+
+| Maintainer | GitHub ID | Affiliation |
+| ---------- | --------- | ----------- |
+| Thomas Parnell | tdoublep | IBM Research |
+| Ghazi Sarwat Syed | GhaziSyed | IBM Research |
+| Chen Wang | wangchen615 | IBM Research |
+