To comply with Assesment requirements regarding agile methodology adopted during the group project, following guide created to highlight key points for our development team rutines.
Important dates and times on agreed shedules
- Weekly physical meetings - Thursdays 11am (yet to confirm)
- Daily standup meetings 2pm exept Thursdays - Discord
- Presentation deadline - Friday, 15 December 2023 16:00 DevOps - (https://learn.solent.ac.uk/mod/assign/view.php?id=3136581)
Sprints dates
- 1st sprint - Sep 25 to Oct 29
- 2nd sprint - Oct 30 to Nov 19
- 3rd sprint - Nov 20 to Dec 15
Development Standards and Best Practices
Table of Contents
Version Control Guidelines
- Commit Messages: Use descriptive and concise commit messages following the conventional commits standard.
- Branch Naming: Adopt a clear and consistent naming convention for branches (e.g., feature/my-new-feature, bugfix/issue-123).
- Pull Requests: Ensure all code changes are reviewed via pull requests, and each PR has a clear purpose and associated issue/feature.
Branching Strategy
- Gitflow: Utilize Gitflow or a similar branching model to organize development, release, and hotfix branches.
- Protected Branches: Define protection rules for specific branches, enforcing code review and preventing direct pushes.
Coding Standards
- Code Style: Follow language-specific style guides (e.g., PEP 8 for Python, ESLint for JavaScript) and maintain consistency across the codebase.
- Naming Conventions: Use meaningful and descriptive names for variables, functions, classes, and other entities.
- Code Comments: Encourage clear and informative comments to explain complex logic or important details in the code.
Code Review Process
- Review Participation: Ensure timely participation in code reviews, providing constructive feedback and suggestions.
- Review Checklist: Develop a checklist covering code quality, functionality, security, and edge cases to guide the review process.
Documentation Guidelines
- README: Every project repository should contain a comprehensive README.md file explaining the project, installation, usage, and other relevant details.
- Inline Documentation: Document complex functions, algorithms, or non-obvious parts of the code using inline comments or docstrings.
Testing Practices
- Test Coverage: Aim for high test coverage using unit tests, integration tests, and end-to-end tests where applicable.
- Continuous Integration: Integrate automated tests into CI/CD pipelines to ensure code quality and prevent regressions.
Deployment Procedures
- Deployment Automation: Implement automated deployment processes using CI/CD tools for consistency and reliability.
- Rollback Strategies: Define clear rollback procedures in case of deployment failures or issues in production.
This Git wiki page acts as a comprehensive reference for developers, outlining the team’s standards, best practices, and guidelines. Feel free to expand on each section with specific examples, tools, or additional details relevant to your team’s workflow and preferences.