Skip to content

Contributor task: Add documentation for contributing and local development #25

Description

@ashishsinghbora

Documentation task

Make Magicloder approachable to external contributors.

Requirements

  • Explain the architecture and repository structure.
  • Explain how to run the daemon, CLI, tests and frontend locally.
  • Explain how an issue should be selected and how PRs should be structured.
  • Document coding conventions and required checks.
  • Add a contributor troubleshooting section.
  • Link to the architecture and API documentation.

Done when

A new contributor can get the project running from a clean machine using only the repository documentation.

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

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions