docs: added page to explain tooling for reviewers

[elijah-potter]

In #455, it became apparent that there is currently a lack of documentation for how to build and test patches to Harper. In response, I've written a short page for contributors that hopefully clear some things up.

I'd love to know what's missing from this page. Is there anything that needs further clarification or revision?

[ccoVeille]

There is something missing here, somewhere-somewhat is the name of the branch in 455.

If you don't explain it, somewhat-somewhere sounds like a meta syntaxic words like "foo-bar"

I'm reporting it, because you lost me.
I had to read carefully 5 times before understanding

[hippietrail]

I think I'm even more lost here than you are -:

[hippietrail]

Is this a follow-on from somewhere previous if I had not just Cargo installed but something more powerful as well/instead?

(am I supposed to click "Add single comment" or "Start a review" here? Going with the former after Copilot failed to help.)

[elijah-potter]

(am I supposed to click "Add single comment" or "Start a review" here? Going with the former after Copilot failed to help.)

Either works.

Is this a follow-on from somewhere previous if I had not just Cargo installed but something more powerful as well/instead?

I'm a little confused by your meaning.

We use just to orchestrate the various build tools we use for different parts of the project (i.e. cargo for Rust, yarn for JavaScript).
Since you don't necessarily need to build any of the JavaScript stuff to test harper-core, we can just use cargo directly.

[hippietrail]

Sorry I'm not talking about the tool "just". I'm confused by the wording about only having Cargo and used "just" as a synonym of "only" in a failed attempt to clarify what I was confused by.

Oh maybe it's saying something like "you don't need all the Javascript stuff to test Harper, you only need Caro"?

[elijah-potter]

Oh maybe it's saying something like "you don't need all the Javascript stuff to test Harper, you only need Caro"?

Precisely

[elijah-potter]

I'm working on improving my ability to write logical documentation. I've given it another go-round. Does it make more sense now?

[hippietrail]

I'm working on improving my ability to write logical documentation. I've given it another go-round. Does it make more sense now?

Yes that's great! Much easier to follow now. Don't worry, everybody knows how hard writing documentation is.

[elijah-potter]

Thanks @hippietrail. In that case, I'm going to merge it.

[hippietrail]

Thanks @hippietrail. In that case, I'm going to merge it.

Thank you! Hopefully I'll get to try it out this afternoon so I'll let you know how I go.

---

Update after trying to add a my_rule.rs

After my initial confusion, I think I managed to edit all the related files by searching for that_which and adding a modified duplicate line after each for my_rule but now I get to the cargo line for testing and it seems to want a URL to a branch. Does this mean that I have to commit my code before I can test it? Or am I missing something?

---

I think I'm getting confused now because the docs are specifically for testing a new published feature in a branch but at the same time I've also been looking at how to implement my own new lint and test that.

I'm not sure both are laid out in full in the docs. I believe that to test my own change I can do cargo run --bin harper-cli but then I need to have a file ready. I tried -- to work with stdin. Maybe that's possible somehow or I could file a feature request.

[elijah-potter]

I'm not sure both are laid out in full in the docs. I believe that to test my own change I can do cargo run --bin harper-cli but then I need to have a file ready. I tried -- to work with stdin. Maybe that's possible somehow or I could file a feature request.

I've added some documentation in #482 on this. Mind taking a look?

[hippietrail]

I'm not sure both are laid out in full in the docs. I believe that to test my own change I can do cargo run --bin harper-cli but then I need to have a file ready. I tried -- to work with stdin. Maybe that's possible somehow or I could file a feature request.

I've added some documentation in #482 on this. Mind taking a look?

Good work thanks. I made a couple of suggestions. And I finally installed just. But I still can't get my new rule to work though.