Hello John, Thank you for participating in the HugeGraph community, whether it is fixing tests, bugs or anything else. The HugeGraph community has some basic suggestions, which are roughly as follows:
1. If you submit some code, or have multiple submissions, you can import the IDEA code style configuration that we provide[1][2], which will greatly simplify unnecessary code formatting/alignment and other issues. 2. We have started to try out PR templates[3] in the graph-computer repository, which will help developers to describe the basic context when submitting PRs (we will soon push it to all repositories). You can refer to its style first (copy it to where you are going to submit PR). In short, we suggest that you demonstrate the difference by screenshots/comparison.[4] 3. If you are fixing a bug, then a good suggestion is to create a corresponding issue (github), and then link (fix) it with your PR. If this bug fix is not easy to see with the naked eye whether it is completely fixed, it is best to add a corresponding example in the unit test (but you can also add it in a follow-up PR). reference: 1. https://github.com/apache/hugegraph/blob/master/hugegraph-style.xml 2. https://github.com/apache/hugegraph/blob/master/CONTRIBUTING.md#32-change-the-code 3. https://github.com/apache/hugegraph-computer/blob/master/.github/PULL_REQUEST_TEMPLATE.md 4. https://github.com/apache/hugegraph-toolchain/pull/465 Imba Jin On 2023/05/30 01:18:01 John Whelan wrote: > Hello, > > I'm starting to look into submitting my first code fix to HugeGraph. As > part of this effort, I have been looking into the submissions of others. > In the examples I saw, the test data and expected results post-fix is shown > in the issue itself. Is this a paradigm that I should follow, or is it > acceptable to first generate a unit test for the problem, write the fix, > then submit them as a pair? > > Regards, > John >
