Skip to content

Improve README for easier setup and contribution  #41

Description

@Muawiya-contact

Problem

New contributors may find it confusing to set up the project or understand how to contribute.

  • The .env.local setup is not clear.
  • Available scripts and workflow are not fully explained.
  • Contribution steps could be more beginner-friendly.

Solution

  • Update README with clear, step-by-step instructions:
    • Clone, install, and run the project
    • Set up environment variables using .env.example → .env.local
    • Explain all scripts and their purpose
    • Provide a clear contribution workflow
  • Add links to Next.js, Prismic, and OpenJS resources
  • Improve readability and consistency

This will help new contributors start faster, reduce errors, and follow standard OSS practices.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions