We need more code comments #2884
Comments
carryxyh
added
help wanted
|
Attach the the coverage data of comments in code(commit id: 1f751a6 ): $ ohcount **/src/main/; ohcount **/src/test/
Examining 855 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 770 56411 22867 28.8% 12220 91498
xmlschema 2 2563 0 0.0% 67 2630
shell 5 240 6 2.4% 26 272
xml 4 40 71 64.0% 25 136
bat 1 22 1 4.3% 6 29
---------------- ----- --------- --------- --------- --------- ---------
Total 782 59276 22945 27.9% 12344 94565
Examining 746 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 631 47409 12869 21.3% 10913 71191
xml 58 786 935 54.3% 348 2069
---------------- ----- --------- --------- --------- --------- ---------
Total 689 48195 13804 22.3% 11261 73260 |
|
I am new to open source contribution world and new to dubbo also. I see this is has been tagged as 'Help wanted' and 'good first issue'. Is there any way I help one this one. Would request someone to be my mentor guide me here as well. |
|
@oldratlee Can you break it down by modules? We can start from the lowest. |
|
I recommend that when you write comments, you change lines in the right place so that it's easy to read. The following comments needs to slide. /**
* Register data, such as : provider service, consumer address, route rule, override rule and other data.
* <p>
* Registering is required to support the contract:<br>
* 1. When the URL sets the check=false parameter. When the registration fails, the exception is not thrown and retried in the background. Otherwise, the exception will be thrown.<br>
* 2. When URL sets the dynamic=false parameter, it needs to be stored persistently, otherwise, it should be deleted automatically when the registrant has an abnormal exit.<br>
* 3. When the URL sets category=routers, it means classified storage, the default category is providers, and the data can be notified by the classified section. <br>
* 4. When the registry is restarted, network jitter, data can not be lost, including automatically deleting data from the broken line.<br>
* 5. Allow URLs which have the same URL but different parameters to coexist,they can't cover each other.<br>
*
* @param url Registration information , is not allowed to be empty, e.g: dubbo://10.20.153.10/org.apache.dubbo.foo.BarService?version=1.0.0&application=kylin
*/
void register(URL url); |
|
@oldratlee，can we statistics the comment coverage as test coverage in the
codecov.io ?
Huxing Zhang <notifications@github.com> 于 2018年12月4日周二 下午9:51写道：
… @oldratlee <https://github.com/oldratlee> Can you break it down by
modules? We can start from the lowest.
—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
<#2884 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAye6KS7dJ-r-XT_biBc9W7obr-FXwNMks5u1n3ygaJpZM4ZAMhZ>
.
|
comment coverage data per module sorted by product code:
PS： Below is the quick-hack script to show coverage data per module: $ for d in `find -mindepth 1 -maxdepth 1 -type d -name 'dubbo*'`; do (
echo
echo "===================================="
echo $d
echo "===================================="
cd $d
ohcount **/src/main/; ohcount **/src/test/
)
done
......
====================================
./dubbo-cluster
====================================
Examining 67 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 62 2544 1400 35.5% 490 4434
---------------- ----- --------- --------- --------- --------- ---------
Total 62 2544 1400 35.5% 490 4434
Examining 38 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 34 3421 822 19.4% 706 4949
xml 1 13 14 51.9% 2 29
---------------- ----- --------- --------- --------- --------- ---------
Total 35 3434 836 19.6% 708 4978
====================================
./dubbo-common
====================================
Examining 121 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 115 15045 5248 25.9% 2610 22903
---------------- ----- --------- --------- --------- --------- ---------
Total 115 15045 5248 25.9% 2610 22903
Examining 183 file(s)
Ohloh Line Count Summary
Language Files Code Comment Comment % Blank Total
---------------- ----- --------- --------- --------- --------- ---------
java 158 8846 2671 23.2% 1899 13416
xml 1 14 18 56.2% 0 32
---------------- ----- --------- --------- --------- --------- ---------
Total 159 8860 2689 23.3% 1899 13448
...... |
|
comment coverage report of 1f751a6 generated by below script: @ralf0131
https://gist.github.com/oldratlee/6d02a849b8b84a9aba26be7ee65f5560 |
I have not found comment coverage info in the codecov.io yet. |
|
Being a new to open source development mythology will be possible for some one to guide me how I can proceed further to help the community regarding the current issue. |
|
Project is here |
|
@khanimteyaz
I recommend that you subscribe to our mailing list. U can subscribe the dev group and go there directly for help, send your questions, I will help you. |
|
@carryxyh |
|
Created the pull request for addition of comments for dubbo-filter module |
|
How can I create the card under project (https://github.com/apache/incubator-dubbo/projects/2) and assigned it to me, so that it can be easier for reported to track. |
|
@khanimteyaz Maybe you don't have the permission. Please leave a comment about what you'd like to add, we can help you do that! Please create an issue for your work, so that I can add your issue the to the project. |
|
@khanimteyaz I've added #2921 to https://github.com/apache/incubator-dubbo/projects/2, and marked it as Done. |
|
@ralf0131 thanks for doing it.Appreciate it. |
|
Hi All,
I have raised the PR <#2967
issue id 2935 <#2935> (adding
dubbo-rpc-api) documentation for filter package. Please review my PR.
#2967
Thanks in advance.
…On Tue, Dec 11, 2018 at 3:25 PM Huxing Zhang ***@***.***> wrote:
@khanimteyaz <https://github.com/khanimteyaz> I've added #2921
<#2921> to
https://github.com/apache/incubator-dubbo/projects/2, and marked it as
Done.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#2884 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AdXcPfCVHdSJjVTrZ87jz4vdQ9BvAZYVks5u34EggaJpZM4ZAMhZ>
.
|
目前我们的代码中，注释的覆盖率非常低，这对于初入dubbo的开发者是不友好的，我们应该开始着手解决这个问题。非常欢迎开发者为我们提交PR来完善注释。
At present, the coverage of comments in our code is very low, which is not friendly to developers who are new to dubbo. We should start to solve this problem. Developers are welcome to submit PRs for us to complete the comments.
:)
The text was updated successfully, but these errors were encountered: