Skip to content

Commit 4683e06

Browse files
authored
📚 Add GOVERNANCE.mdfile (#1716)
* 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]>
1 parent eba7e36 commit 4683e06

File tree

3 files changed

+94
-1
lines changed

3 files changed

+94
-1
lines changed

GOVERNANCE.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# 📚 Anomalib Project Governance Model
2+
3+
## 🌟 Introduction
4+
5+
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.
6+
7+
## 🏛 Governance Structure
8+
9+
### 🤝 Decision-Makers
10+
11+
- **👤 Project Manager**: Responsible for overall project coordination, decision-making, and stakeholder communication.
12+
- **👥 Technical Lead Team**: Comprises core developers and experts in anomaly detection. They make technical decisions and guide the project's technical direction.
13+
- **🔑 Advisory Board**: Consists of industry experts, stakeholders, and potential users who provide strategic guidance and feedback.
14+
15+
### 📋 Roles and Responsibilities
16+
17+
- **👤 Project Manager**:
18+
- Responsibilities: Project planning, team coordination, stakeholder communication, risk management.
19+
- Decision-making authority: Final say in project direction, resource allocation, and conflict resolution.
20+
- **👥 Technical Lead Team**:
21+
- Responsibilities: Technical architecture, code review standards, tool selection, research and development.
22+
- Decision-making authority: Technical decisions, methodology selection, technical problem solving.
23+
- **🧑‍💻 Contributors**:
24+
- Responsibilities: Developing features, fixing bugs, contributing to documentation.
25+
- **🤵 Stakeholders**:
26+
- Involvement in decision-making process: Provide feedback and strategic direction through the Advisory Board.
27+
28+
### 🔄 Decision-Making Processes
29+
30+
- **💡 Proposal Process**: Contributors propose ideas via GitHub issues. Technical Lead Team reviews proposals periodically.
31+
- **🗣 Discussion and Evaluation**: Proposals are discussed in weekly technical meetings. Feedback is provided through GitHub comments.
32+
- **✅ Approval Process**: Technical Lead Team votes on proposals. Majority vote is required. Project Manager has veto power.
33+
- **📢 Communication of Decisions**: Decisions are communicated via the Discussions on GitHub.
34+
35+
## 📡 Communication Channels
36+
37+
- **📅 Regular Meetings**: Daily/Weekly technical meetings; Monthly stakeholder update meetings.
38+
- **🛠 Project Management Tools**: GitHub for code and issue tracking; Teams for daily communication.
39+
- **📧 Email and Instant Messaging**: Email for formal communications; Teams for instant messaging.
40+
41+
## 🚀 Implementation and Communication
42+
43+
- **🎉 Kickoff Meeting**: Held at project start to introduce governance model to the team and stakeholders.
44+
- **📚 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.
45+
46+
## 🔍 Monitoring, Review, and Adaptation
47+
48+
- **👀 Monitoring and Review Schedule**: The governance model is reviewed bi-annually for effectiveness and efficiency.
49+
- **🔄 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.
50+
51+
## 📢 Conclusion
52+
53+
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.

MAINTAINERS.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# 🛠 Maintainers
2+
3+
This document provides a list of maintainers who are responsible for the overall
4+
codebase, ensuring that the project is moving forward in a coordinated way.
5+
If you have any questions or need assistance, feel free to reach out to any of
6+
the maintainers listed below.
7+
8+
## 👥 Core Maintainers
9+
10+
- **Samet Akcay**
11+
12+
- GitHub: [@samet-akcay](https://github.com/samet-akcay)
13+
14+
15+
- **Dick Ameln**
16+
17+
- GitHub: [@djdameln](https://github.com/djdameln)
18+
19+
20+
- **Ashwin Vaidya**
21+
- GitHub: [@ashwinvaidya17](https://github.com/ashwinvaidya17)
22+
23+
24+
## 🤝 Contributing
25+
26+
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.
27+
28+
Here is a list of contributors of Anomalib:
29+
30+
<a href="https://github.com/openvinotoolkit/anomalib/graphs/contributors">
31+
<img src="https://contrib.rocks/image?repo=openvinotoolkit/anomalib" />
32+
</a>
33+
34+
## 🙏 Acknowledgements
35+
36+
We'd like to thank all the contributors who have helped shape this project. Your support and contributions are greatly appreciated!
37+
38+
---
39+
40+
This list of maintainers is subject to change as the project evolves. Please check back here for the most up-to-date information.

requirements/base.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ matplotlib>=3.4.3
99
omegaconf>=2.1.1
1010
opencv-python>=4.5.3.56
1111
pandas>=1.1.0
12-
lightning
12+
lightning>2,<2.2.0 # We need to sort out the compatibility with the latest version of Lightning
1313
setuptools>=41.0.0
1414
timm>=0.5.4,<=0.6.13
1515
torch>=2,<2.2.0 # rkde export fails even with ONNX 17 (latest) with torch 2.2.0. TODO(ashwinvaidya17): revisit

0 commit comments

Comments
 (0)