Document how to set up a local development environment

Open Beginner friendly
#146 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust
Domain
documentation

Research direction

Start by reading the existing README and checking whether a CONTRIBUTING.md is present. Follow the current local build and test process for mewnala, then document the required setup and commands in the README or CONTRIBUTING.md. Done means a new contributor can build and test the project locally without the reported friction.

Written by the indexing model from the issue text.

Description

documentation

While trying to test PRs in libprocessing, I ran into friction setting up a local development environment for mewnala. It would be helpful to have clear instructions in the README (or in a dedicated CONTRIBUTING.md) explaining how to build and test mewnala locally.

Dominant language
Rust
Stars
69
Forks
14
Avg merge
15d 22h
Merged PRs (30d)
3

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from processing/libprocessing

All issues in processing/libprocessing

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.