Overcoming Barriers for New Contributors

[kneerose]

The README for the govtool-outcome-pillars repository appears to be outdated, as it is inherited from the boilerplate repository: web-app-boilerplate-template.
This lack of customisation makes it difficult for new contributors to understand the project's purpose, setup process, and contribution guidelines.

Suggestions:

• Update the README to reflect the specific purpose and scope of govtool-outcome-pillars.
• Include a project overview, key features, and contribution guidelines tailored to the repository.
• Provide clear instructions for cloning, setting up, and running the project locally.
• Remove or replace boilerplate content irrelevant to the project.

Backend

The backend README is similarly outdated, also derived from the boilerplate repository. This creates confusion for contributors attempting to work on the backend, as it lacks project-specific setup and runtime instructions.

Suggestions:

• Customize the backend README with project-specific details, including the backend's role in govtool-outcome-pillars.
• Add prerequisites (e.g. required runtime environment, database setup, or dependencies).
• Include step-by-step instructions for setting up and running the backend locally.

Outcomes-UI Package

Location: outcome-ui package
Issue: The README for the outcome-ui package is incomplete, focusing only on installing the published package. It lacks critical information for contributors, such as:

• Setup and build instructions for running the frontend locally.
• Guidance on contributing fixes or features.
• Instructions for using the package in other projects.