docs: rewrite README, add CONTRIBUTING with conventional commits#100
Conversation
Signed-off-by: Sudipto Baral <sudiptobaral.me@gmail.com>
Signed-off-by: Sudipto Baral <sudiptobaral.me@gmail.com>
| @@ -0,0 +1,28 @@ | |||
| Create a GitHub issue markdown file from the details provided by the user. | |||
There was a problem hiding this comment.
Is there any reason not to use the "gh" command to create the actual issue in https://github.com/G-Research/spark/issues rather than just a markdown file?
There was a problem hiding this comment.
Yes, I considered that as well. However, since we create issues across different boards/projects, sometimes in armada-spark and sometimes in gr/spark, I kept it simple for now and generated a markdown file instead.
| - `### Steps to Reproduce` — numbered list (if applicable) | ||
| - `### Expected Behavior` — 1-2 sentences | ||
| - `### Actual Behavior` — include relevant log snippets in code blocks, keep them short (trim stack traces to the key lines) | ||
| - `### Potential Root Cause` — based on your codebase investigation, explain where the issue likely lives. Link to source code using upstream GitHub URLs: `https://github.com/armadaproject/armada-spark/blob/master/...#L<start>-L<end>`. For Apache Spark references, link to the `apache/spark` repo at the relevant tag. |
There was a problem hiding this comment.
the master branch changes a lot. A "sha" based url like this:
https://github.com/sudiptob2/armada-spark/blob/c92e9e868a9f35fd14fd201d0b783a11c7e7dae5/.claude/settings.json#L8-L11
would be more stable/accurate.
There was a problem hiding this comment.
I tried, but Claude occasionally generates the wrong SHA, causing broken links. It needs some investigation, but should be doable.
GeorgeJahad
left a comment
GeorgeJahad
left a comment
There was a problem hiding this comment.
lgtm, left a couple of minor notes. thanks @sudiptob2 !
2 participants
What
Rewrite README for clarity and add a CONTRIBUTING guide with conventional commit conventions.
Why
The README had stale version numbers (Spark 3.5.3 / Scala 2.13.15 instead of 3.5.5 / 2.13.8), an incorrect E2E script name, a wrong set-version.sh
argument format, and an outdated client-mode config example. Contributing guidelines and commit conventions were not documented anywhere, making it
hard for new contributors to follow project standards.
Changes
prefix, fix script names and argument formats, point development section to CONTRIBUTING.md