dojo icon indicating copy to clipboard operation
dojo copied to clipboard

Published 20 hours ago • verified publisher icon dojoengine

Document the build process for contributors

Open glihm opened this issue 1 year ago • 4 comments

Currently, there's no explicit guide for a new contributor to what are the steps and options to build dojo and work on the code base.

This issue aims at adding a section into the README to explain new contributors how to:

  1. Get dojo cloned
  2. How to build (full workspace, how to work on a crate only, etc...)
  3. How to test (same, full workspace, only some crates, etc...)
  4. Which checks have to be done
  5. use the scripts in scripts/

glihm avatar Mar 27 '24 14:03 glihm

adding a PR template with a checklist for doing clippy,fmt checks etc would be helpful

kariy avatar Mar 28 '24 05:03 kariy

assign me this task will love to work on this

ebukizy1 avatar Apr 22 '24 01:04 ebukizy1

assign me this task will love to work on this

Thank you for the proposal man, I'm actually wrapping up some documentation at different level and it includes this one.

Please don't hesitate if others issues make sense to you, will also wrap up the review on the book of your PR.

glihm avatar Apr 22 '24 12:04 glihm

okay thanks alot

ebukizy1 avatar Apr 22 '24 13:04 ebukizy1