docs: correct formatting issues

[kj800x]

I'm not entirely sure of the correct syntax or the process for testing these docs locally (just doing a drive-by commit on GitHub). I noticed that some of the Warning blocks in the docs had broken formatting. This PR should fix that.

Before

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 63.42%. Comparing base (d07cf71) to head (6642447).
Report is 7 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #983      +/-   ##
==========================================
- Coverage   71.99%   63.42%   -8.57%     
==========================================
  Files          24       15       -9     
  Lines        3642     2212    -1430     
==========================================
- Hits         2622     1403    -1219     
+ Misses        880      723     -157     
+ Partials      140       86      -54     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[chengfang]

@kj800x thanks for the fix. Can you fix the DCO error by signing off the commit? After that, it should be good to go.

[kj800x]

Thanks for taking a look! I noticed the DCO check failed and looked into it, but I'm not familiar with what 'signing off' a commit entails or its significance. Since this isn't mentioned in the README or contributing documentation, would you mind clarifying? I'm hesitant to sign my name to something without knowing what that means. It might also be helpful to add guidance on this to the contributing docs for future contributors.

[chengfang]

In this project we use sign-off as a way for PR submitters to certify their consent to license and code ownership, which is a common practice among open source projects, though there are some other projects that do not require it. For a formal explanation you may want to check git-commit man page or other formal docs.

[chengfang]

I've updated the development guide to include the DCO signoff requirement. Thanks for bringing that up. Do you have any other concerns or questions regarding this PR?

[kj800x]

Thanks for updating that. I'm happy to update the commits with that in mind. From what I'm seeing in the man page you suggest, the meaning of a signoff depends on the project to which you're committing. It lists http://developercertificate.org as one example of what that may mean, but ultimately leaves it project dependent. I don't think it's reasonable for contributors to assume that it means DCO (absent other documentation), nor does this seem to be a common practice in my personal experience.

       -s, --signoff, --no-signoff
           Add a Signed-off-by trailer by the committer at the end of the
           commit log message. The meaning of a signoff depends on the project
           to which you’re committing. For example, it may certify that the
           committer has the rights to submit the work under the project’s
           license or agrees to some contributor representation, such as a
           Developer Certificate of Origin. (See
           http://developercertificate.org for the one used by the Linux
           kernel and Git projects.) Consult the documentation or leadership
           of the project to which you’re contributing to understand how the
           signoffs are used in that project.

           The --no-signoff option can be used to countermand an earlier
           --signoff option on the command line.

All that said, I think the updates that you've made to your documentation have now made the meaning for your project clear. Thank you! I'll be force pushing updated commits momentarily!