Challenge 3: Improving API Usability, Testing, and Documentation through a Hackathon
As a Product Owner, I want to organize a hackathon to address the top three concerns identified by the Software Developer Labor Union in their recent happiness survey. The goal is to improve API design, increase test coverage, and enhance API documentation, utilizing GitHub Copilot to facilitate solutions and improve team morale and productivity.
Why:
Morale and Productivity: A recent survey by the Software Developer Labor Union indicates all-time low morale and productivity, with major concerns about the quality and maintainability of our codebase.
CEO's Commitment: In response to the survey, the COO has promised improvements, including providing Copilot licenses to all developers to aid in resolving these issues.
Enhanced Collaboration: The hackathon will serve as a platform to address these frustrations collectively, demonstrating the capabilities of Copilot in real-time problem-solving.
Acceptance Criteria:
Restful API Design:
Redesign APIs to adhere to RESTful principles. This includes splitting complex controllers like EventController.cs into more manageable parts.
Unit Testing:
Establish significant unit tests for existing and newly designed APIs to ensure they meet functional and performance standards.
Update CI/CD pipelines to automatically run these unit tests, ensuring that all future changes pass testing before deployment.
API Documentation and Discoverability:
Create comprehensive OpenAPI specifications for all internal APIs to improve discoverability and usability.
Use Swagger to show this documentation, making it easily accessible to all teams.
Tasks:
[ ] Activate GitHub Copilot for all participating developers.
[ ] Use Copilot to refactor EventController.cs into a RESTful API.
[ ] Ask Copilot for assistance in writing comprehensive documentation and creating a Swagger page for API docs.
[ ] Write and update unit tests for the APIs, and integrate these tests into the CI/CD pipelines.
"Coming together is a beginning, staying together is progress, and working together is success." - Henry Ford
Challenge 3: Improving API Usability, Testing, and Documentation through a Hackathon
As a Product Owner, I want to organize a hackathon to address the top three concerns identified by the Software Developer Labor Union in their recent happiness survey. The goal is to improve API design, increase test coverage, and enhance API documentation, utilizing GitHub Copilot to facilitate solutions and improve team morale and productivity.
Why:
Acceptance Criteria:
Restful API Design:
EventController.csinto more manageable parts.Unit Testing:
API Documentation and Discoverability:
Tasks:
EventController.csinto a RESTful API.