Add Documentation for Contributors and Jira Task Creation

- Introduced a new CONTRIBUTORS.md file to outline the team structure and roles involved in the project, enhancing transparency and collaboration.
- Created a JIRA_TASK_RULES.md file detailing mandatory rules and standards for creating Jira tasks, ensuring consistency and clarity in task management.
- Included guidelines on task labels, sprint assignments, relationships, and structure to streamline the task creation process.
- Added critical reminders to emphasize the importance of proper task management practices within the team.
This commit is contained in:
n.nakhostin
2025-09-17 10:31:38 +03:30
parent b429bcd24f
commit 6906577f6e
3 changed files with 129 additions and 0 deletions
+53
View File
@@ -0,0 +1,53 @@
# Contributors
This project is developed and maintained by the following team members:
## Team Structure
### Tech Lead
- **h.barzegar** - Technical leadership and architecture decisions
### Team Lead
- **n.nakhostin** - Project management and team coordination
### Analytics
- **n.sagharidooz** - Data analysis and business intelligence
### Backend Developer
- **n.nakhostin** - Server-side development and API implementation
### Panel Developer
- **a.jamali** - Web panel frontend development
- **sina_nokhostin** - Web panel frontend development
### Landing Developer
- **sina_nokhostin** - Web landing frontend development
### Application Developer
- **a.ghabeli** - Mobile application development
### QA
- **a.sheikhmemari** - Quality assurance and testing
### Designer
- **s.fathali** - UI/UX design and user experience
### DevOps
- **n.nakhostin** - Infrastructure and deployment
- **h.barzegar** - Infrastructure and deployment
---
## Project Information
**Project Name:** Tender Management Backend
**Repository:** TM/tm_back
**Technology Stack:** Go, MongoDB, Echo v4, JWT Authentication
## Contact
For questions or contributions, please contact the Tech Lead or Team Lead.
---
*Last updated: 17 September 2025*
+70
View File
@@ -0,0 +1,70 @@
# Jira Task Creation Rules and Standards
## 📋 **Mandatory Rules for Creating Jira Tasks**
### 1. **Labels - REQUIRED**
Always set appropriate labels based on task type:
- **Application tasks** → `application`
- **Panel tasks** → `panel`
- **Backend tasks** → `backend`
- **DevOps tasks** → `devops`
- **QA tasks** → `qa`
- **Design tasks** → `design`
### 2. **Sprint Assignment - MANDATORY**
- **ALL tasks** must be assigned to the **CURRENT ACTIVE SPRINT**
- Never assign to past or future sprints
- Always check current sprint before task creation
### 3. **Task Relationships - REQUIRED**
- If task has a reference → use `relates to`
- If task is dependent → use `depends on`
- If task is a subtask → use `parent`
- Always link related tasks with proper relationship type
### 4. **Team Assignment by Role**
- **Application Developer:** a.ghabeli
- **Panel Developer:** a.jamali, sina_nokhostin
- **Backend Developer:** n.nakhostin
- **QA:** a.sheikhmemari
- **Designer:** s.fathali
- **DevOps:** n.nakhostin, h.barzegar
### 5. **Task Structure Standards**
- **Summary:** Clear, concise task title
- **Description:** Detailed requirements and context
- **Acceptance Criteria:** Checklist format with [ ] checkboxes
- **Backend Integration:** Include API details if applicable
- **Related Tasks:** Add references in comments
### 6. **Task Types**
- **Task:** General development work
- **Bug:** Issues and fixes
- **Story:** User stories and features
- **Subtask:** Child tasks under parent tasks
### 7. **Priority Levels**
- **Highest:** Critical issues, blocking bugs
- **High:** Important features, major bugs
- **Medium:** Standard features, minor bugs
- **Low:** Nice-to-have features, enhancements
### 8. **Comments and Updates**
- Always add comments when linking related tasks
- Include technical details and dependencies
- Update task status regularly
- Add progress updates in comments
---
## 🚨 **CRITICAL REMINDERS**
1. **NEVER** create tasks without proper labels
2. **ALWAYS** assign to current active sprint
3. **MUST** link related tasks with proper relationships
4. **REQUIRED** to include detailed acceptance criteria
5. **MANDATORY** to assign to correct team member
---
*This document serves as the standard for all Jira task creation in the TM project.*
*Last updated: September 17, 2025*
+6
View File
@@ -2,6 +2,12 @@
A comprehensive tender management backend system built with Go, following Clean Architecture principles with Domain-Driven Design (DDD) patterns.
## 👥 Team
Meet our development team and their roles in this project.
**[👥 View Team Members](./CONTRIBUTORS.md)** - Complete team structure and contact information
## 📚 Documentation
All documentation has been organized in the [`docs/`](./docs/) directory for better structure and maintainability.