Parrot: Write program to create wiki page identifying 'hack' comments in source code
completed by: Nagato Yuki
mentors: James E Keenan
Parrot's source code contains many comments which characterize adjacent code as 'hacks'. Since there is no universally accepted definition of 'hack', it is not clear what action, if any, needs to be taken to improve the allegedly hack-ish code. But, at the very least, we need a way to locate all such comments. It has been suggested that a program be written in Perl 5, PIR or NQP-RX that locates such comments and creates a wiki page on the Parrot trac site that links 'hack' comments to source code pages on Parrot's github site.
Steps To Complete This Task
- Create a fork of parrot.git on github.com
- Perform all the necessary code and/or documentation changes
- Build parrot and run it's test suite (make fulltest) to verify that things still work
- You can also submit a smoke report with "make smoke", but that is optional.
- Create a Github pull request (button on the upper right of your fork) to have your changes incorporated into the master repository
- Would enable Parrot developers to locate areas in source code potentially in need of refactoring.
- Perl 5