rockstor / rockon-validator Goto Github PK

I realized that I may want to reuse the model from this tool, so in order to make it reusable outside this repo, I need to make it a separate package.

In the interest of establishing our common practice re non automated pull requests, I think it would be good if we always have issues that indicate the problem one is trying to solve. Years later there is then more context as others (later versions of ourselves) can see the origin of a task:

1. (Issue) I set out to solve this issue. I.e. Aim.
2. (Pull request) I ended up approaching it (referenced Fixed/Closes issue) this way. I.e. Proposal, in context.

That way we have more context as sometimes the solution is just wrong - but the problem remains. Or what the problem (issue) stated was the case(problem), was found to be wrong in the focused solution (PR). When we are unlucky we see both were misguided - but in that case we have two points of references to guide us/others further.

Ergo I suggest we try in this repo, like almost all others in the Org, to follow the regime introduced by the project founder @schakrava to me originally as I began contributing here. Also helps with defining scope and assisting with identifying if scope creep has/or is about to occur.

Originally posted by @phillxnet in #4 (comment)

As this is no longer a solo project, having been donated to the Rockstor project, it should fall in line with the expected contribution rules for that project, as mentioned above. As of now, I believe those guidelines include:

• An issue created for every PR to link to (to track the "problem" separately from the "solution")
• Squashed (single-commit) PR merges

After reading https://rockstor.com/docs/contribute/contribute.html#shipping-changes , I am unaware if there are any others that should be listed (there isn't a testing branch here to base PRs off, or I would have added that as a criteria).

I would request that we

• Add a formalized list to CONTRIBUTING.md in the root of the repo
• Enforce squashed merges in the repo settings

Given this entire repository was donated by @StephenBrown2 via a GitHub repo transfer to the Organisation of 'The Rockstor Project', there is now a need to update related embedded URLs:

• README.md
• go.mod

The Rock-On documentation is inconsistent with the code that parses it, thus the model it was based on was not omitting certain values when they could be.

Goal: Omit all optional values in the Rock-On json.