Skip to content

Commit

Permalink
📚 Add GOVERNANCE.mdfile (#1716)
Browse files Browse the repository at this point in the history
* Create governance.md file

Signed-off-by: Samet Akcay <[email protected]>

* Dont install the latest lightning version

* Update base.txt

* Add maintainers.md file

* Merge origin

---------

Signed-off-by: Samet Akcay <[email protected]>
  • Loading branch information
samet-akcay authored Feb 8, 2024
1 parent eba7e36 commit 4683e06
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 1 deletion.
53 changes: 53 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 📚 Anomalib Project Governance Model

## 🌟 Introduction

This document outlines the governance model for Anomalib. The governance model is crucial for ensuring clear decision-making, accountability, and efficient progress towards the project's goals.

## 🏛 Governance Structure

### 🤝 Decision-Makers

- **👤 Project Manager**: Responsible for overall project coordination, decision-making, and stakeholder communication.
- **👥 Technical Lead Team**: Comprises core developers and experts in anomaly detection. They make technical decisions and guide the project's technical direction.
- **🔑 Advisory Board**: Consists of industry experts, stakeholders, and potential users who provide strategic guidance and feedback.

### 📋 Roles and Responsibilities

- **👤 Project Manager**:
- Responsibilities: Project planning, team coordination, stakeholder communication, risk management.
- Decision-making authority: Final say in project direction, resource allocation, and conflict resolution.
- **👥 Technical Lead Team**:
- Responsibilities: Technical architecture, code review standards, tool selection, research and development.
- Decision-making authority: Technical decisions, methodology selection, technical problem solving.
- **🧑‍💻 Contributors**:
- Responsibilities: Developing features, fixing bugs, contributing to documentation.
- **🤵 Stakeholders**:
- Involvement in decision-making process: Provide feedback and strategic direction through the Advisory Board.

### 🔄 Decision-Making Processes

- **💡 Proposal Process**: Contributors propose ideas via GitHub issues. Technical Lead Team reviews proposals periodically.
- **🗣 Discussion and Evaluation**: Proposals are discussed in weekly technical meetings. Feedback is provided through GitHub comments.
- **✅ Approval Process**: Technical Lead Team votes on proposals. Majority vote is required. Project Manager has veto power.
- **📢 Communication of Decisions**: Decisions are communicated via the Discussions on GitHub.

## 📡 Communication Channels

- **📅 Regular Meetings**: Daily/Weekly technical meetings; Monthly stakeholder update meetings.
- **🛠 Project Management Tools**: GitHub for code and issue tracking; Teams for daily communication.
- **📧 Email and Instant Messaging**: Email for formal communications; Teams for instant messaging.

## 🚀 Implementation and Communication

- **🎉 Kickoff Meeting**: Held at project start to introduce governance model to the team and stakeholders.
- **📚 Training Sessions**: Conducted as needed to onboard new contributors and stakeholders on the governance model, ensuring they understand their roles, responsibilities, and the decision-making processes within the project.

## 🔍 Monitoring, Review, and Adaptation

- **👀 Monitoring and Review Schedule**: The governance model is reviewed bi-annually for effectiveness and efficiency.
- **🔄 Adaptation Process**: Adjustments to the governance model are proposed by the Project Manager, discussed with the Technical Lead Team, and approved by the Advisory Board. Changes are documented and communicated through email and Teams.

## 📢 Conclusion

The Anomalib project's governance approach is made to guarantee fast project progress, effective communication, and transparent decision-making. By following this model, we want to accomplish the objectives of the project and promote a cooperative and welcoming atmosphere for all participants and stakeholders.
40 changes: 40 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# 🛠 Maintainers

This document provides a list of maintainers who are responsible for the overall
codebase, ensuring that the project is moving forward in a coordinated way.
If you have any questions or need assistance, feel free to reach out to any of
the maintainers listed below.

## 👥 Core Maintainers

- **Samet Akcay**

- GitHub: [@samet-akcay](https://github.com/samet-akcay)
- Email: [email protected]

- **Dick Ameln**

- GitHub: [@djdameln](https://github.com/djdameln)
- Email: [email protected]

- **Ashwin Vaidya**
- GitHub: [@ashwinvaidya17](https://github.com/ashwinvaidya17)
- Email: [email protected]

## 🤝 Contributing

We welcome contributions from everyone. If you're interested in helping out, please see our [CONTRIBUTING.md](./CONTRIBUTING.md) file for more information on how to get started. If you're unsure where to begin or have any questions about contributing, feel free to reach out to any of the maintainers listed above.

Here is a list of contributors of Anomalib:

<a href="https://github.com/openvinotoolkit/anomalib/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openvinotoolkit/anomalib" />
</a>

## 🙏 Acknowledgements

We'd like to thank all the contributors who have helped shape this project. Your support and contributions are greatly appreciated!

---

This list of maintainers is subject to change as the project evolves. Please check back here for the most up-to-date information.
2 changes: 1 addition & 1 deletion requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ matplotlib>=3.4.3
omegaconf>=2.1.1
opencv-python>=4.5.3.56
pandas>=1.1.0
lightning
lightning>2,<2.2.0 # We need to sort out the compatibility with the latest version of Lightning
setuptools>=41.0.0
timm>=0.5.4,<=0.6.13
torch>=2,<2.2.0 # rkde export fails even with ONNX 17 (latest) with torch 2.2.0. TODO(ashwinvaidya17): revisit
Expand Down

0 comments on commit 4683e06

Please sign in to comment.