search

ministryofjustice / operations-engineering

This repository is home to the Operations Engineering's tools and utilities for managing, monitoring, and optimising software development processes at the Ministry of Justice. • This repository is defined and managed in Terraform
https://user-guide.operations-engineering.service.justice.gov.uk/
MIT License
12 stars 5 forks source link

Improve the Standardisation of our GitHub Repositories #3797

Open jasonBirchall opened 10 months ago

jasonBirchall commented 10 months ago

User Need

As a GitHub Administrator, I want to utilise the data from our repository standards reports effectively, so that I can encourage and ensure higher compliance with these standards across all our GitHub repositories.

Value

By actively using the report data to drive up compliance with repository standards, we can improve our projects' overall quality, security, and maintainability. Higher adherence rates enhance the performance and reliability of our repositories and build a culture of excellence and best practices among our developers.

Functional Requirements:

  1. Analyse the report data to identify common areas of non-compliance and potential reasons for the low adherence rates.
  2. Develop a strategy to engage with repository owners or teams, providing them with specific insights into their compliance status and practical steps for improvement.
  3. Implement an incentives program (like improved visibility, recognitions, or other perks) for repositories that consistently meet or exceed the standards.
  4. Offer workshops, training sessions, or documentation to educate and assist developers in understanding and meeting these standards.
  5. Establish a feedback loop from repository owners to understand barriers to compliance and potential improvements to the standards.

Non-Functional Requirements:

  1. The engagement and improvement strategy should be constructive and encouraging, not punitive, to foster a positive and collaborative compliance culture.
  2. Any educational or support initiatives should be accessible and straightforward, aiming to minimize the effort and complexity of complying with standards.
  3. Data privacy and sensitivity should be maintained while handling reports and communicating with repository owners.

Acceptance Criteria:

  1. A significant increase in the percentage of repositories adhering to the defined standards is observed within a targeted timeframe post-implementation of the strategy.
  2. Repository owners clearly understand the standards and actively engage in aligning their repositories accordingly.
  3. The feedback from developers and repository owners is generally positive, indicating a supportive and effective approach to standard adherence.
AntonyBishop commented 9 months ago

Requires breaking down. Too large.

AntonyBishop commented 9 months ago

Requires breaking down. Too large.

AntonyBishop commented 9 months ago

Breakdown completed. Child Stories to be added to EPIC.