BRL-CAD is huge. Thousands of files spread across 165 directories. Maintaining a high quality of source code and documentation is a never ending task, but one anyone can help with.
Sound's easy, but you might be surprised because you need to ignore all of the source code and function variables that will easily trip up any automatic spell-check program. You basically only care about spelling mistakes within comments. Even for our documentation, much of it is formatted in xml and you have to ignore all of the xml tags.
This task involves finding and fixing simple spelling mistakes. To complete the task, you need to find 10 or more different spelling mistakes in at least 10 different files. You have to fix all occurrences of the spelling mistake across all those files. Make sense?
Remember to check and fix all occurrences of the mistakes in all 10+ files, make and submit it as a patch file.
BE SURE TO HAVE UP-TO-DATE SOURCES!!! We find and fix spelling mistakes on a daily basis and throughout the day. You have to find mistakes that are not already fixed or reported.
To clarify:
- 1 mistake in 7 different files counts as: 1 and 7
- 20 mistakes in 2 files counts as: 10 and 2
- 5 mistakes across 20 files counts as: 5 and 10
- You need to find: =10 mistakes AND =10 files
| File name/URL | File size | Date submitted | |
|---|---|---|---|
| GCI2012-10mistakes10files-patch.diff | 9.7 KB | December 07 2012 22:50 UTC | |
| GCI2012-10mistakes10files-patch.diff | 11.5 KB | December 08 2012 17:57 UTC |
I would like to work on this task.
This task has been assigned to Andy Le. You have 48 hours to complete this task, good luck!
For clarification, is the documentation that must be checked found from this webpage or another one?
http://brlcad.org/wiki/Documentation
Thanks,
Andy Le
The spelling mistakes must be found within our source checkout files. To obtain a source checkout, see these instructions:
http://brlcad.org/wiki/Deuces#Getting_Started
They can be in any file, not just within documentation files but if you want to focus on documentation, they're the files in the "doc" subdirectory.
Melange has detected that the initial deadline has passed and it has set the task status to ActionNeeded. The student has 24 hours to submit the work before the task is reopened and sent back to the pool for other students to claim.
Melange has detected that the final deadline has passed and it has reopened the task.
I would like to work on this task.
Sean, you've claimed and unclaimed a task too many times today. What are you doing?
Please commit to a task for more than a couple minutes.
The claim on this task has been removed, someone else can claim it now.
I would like to work on this task.
The claim on this task has been removed, someone else can claim it now.
I would like to work on this task.
This task has been assigned to Monika. You have 48 hours to complete this task, good luck!
Where can I find help with creating patch files?
http://brlcad.org/wiki/Deuces#When_You.27re_Done
It's pretty easy. Just change dir to where the chnaged file is and type svn diff /path/patch_name.patch
Thanks so much! Unfortunately I haven't been able to find enough misspellings
The claim on this task has been removed, someone else can claim it now.
I would like to work on this task.
This task has been assigned to Anshul. You have 48 hours to complete this task, good luck!
Monika,
Were you able to find any? You may be able to help the next person if you can identify any you did find.
I'm fairly certain that in the 'AUTHORS.txt' file, 'Northrup Research and Technology Center' should actually be 'Northrop Research and Technology Centre'.
Anshul, do you need more time?
Monica, the more I remember back that far, I'm actually vaguely remembering that Northrup is the correct spelling - that it wasn't Northrop Grumman -- but I'll have to consult some of our archives to find out for sure.
Hi Sean,
I don't have the task but I'd still like to help out. I believe in the "history.txt" file the doc folder there are a few typos.
acedemic should be academic
contries should be countries
Crysler Motors should be Chrystler Motors
Veterns Administartion should be Veterans Administaration
addtion should be addition
Andy,
If Anshul continues to be unresponsive and doesn't complete the task, perhaps you can reclaim it. I think there may still be another spelling task too.
Cheers!
I'm not completely sure, but I wasn't referring to Northrop Grumman, but Northrop Corporation's 'Northrop Research and Technology Centre' in California which closed down several years ago. It may still be Northrup however, so let me know!
Melange has detected that the initial deadline has passed and it has set the task status to ActionNeeded. The student has 24 hours to submit the work before the task is reopened and sent back to the pool for other students to claim.
Melange has detected that the final deadline has passed and it has reopened the task.
I would like to work on this task.
This task has been assigned to An Ha. You have 48 hours to complete this task, good luck!
Be sure to use our very latest sources from a Subversion checkout. Good luck!
Hi, when finding and fixing spelling mistakes, would it count if the word needs to be capitalized? Also, does grammatical mistakes count too? Such as two "the"'s in a sentence? So for example, "The the cat is running"?
Also, in the last task for finding spelling, you said to ignore files in the src directory, would I have to do that for this one too?
The work on this task is ready to be reviewed.
So, we'll give you the grammatical errors since they're good catches, but not capitalization. There are thousands of places all over the code where statements are intentionally written in all lowercase out of convenience or insignificance. "Fixing" those does nothing to improve our auality. The repeated word errors are, however.
Tallying up what you found, you hit exactly 10 files (two didn't count), but you're three words shy:
Looking great, just need to find a few more. Try looking in the src/* subdirectories that don't begin with 'lib'. There are lots.
Note ax_boost_base.m4 (like src/other) doesn't count, it's not ours to change.
One of the mentors has sent this task back for more work. Talk to the mentor(s) assigned to this task to satisfy the requirements needed to complete this task, submit your work again and mark the task as complete once you re-submit your work.
The work on this task is ready to be reviewed.
Which three others did you find? I see sigle and acutal but what's the third?
The third one is sigle-click, which should be single-click
If you want, I can find one more if you don't accept that one as another spelling mistake.
Nope, that's all good. I just couldn't find it. The src/other changes don't count as they're not our sources to modify, but that one was fortunately also in one of our files. Nicely done.
Approximately how long did it take you to find and fix those mistakes? If you had to do it again, how long do you think it'd take you now that you've done it once?
We will likely create more tasks like this one.
Congratulations, this task has been completed successfully.
The time it took me for those 10 mistakes and 10 files was about 5-6 hours just quickly skimming through the files via vim and the spell check feature it has :)
The other task I did was 5 mistakes and 40 files and that was in total about the same (excluding the problems I had downloading the repo :P).
I'll be looking forward to completing more of these tasks.
Thanks for the information. It sounds like the tasks are roughly scoped appropriately. I hope that once you found a mistake, you ran a recursive grep on our files to find multiple occurences. ;)
Yeah, I just ran find and sed and it will do the rest for me :)
Your changes have now been applied (r54092) to our sources and will be included in the next release of BRL-CAD. Thanks for your efforts!