search

chesslablab / php-chess

A chess library for PHP offering move validation, common formats, multiple variants, UCI engine support, explanation of chess positions, and image recognition.
https://chesslablab.github.io/php-chess/
MIT License
110 stars 52 forks source link

Document Chess\Eval\DefenseEval with comments #607

Closed programarivm closed 1 month ago

programarivm commented 1 month ago

Document Chess\Eval\DefenseEval with comments to briefly explain the purpose of each part. Remember to write a brief description of the heuristic along with an explanation of how it has been implemented.

Neel-07 commented 1 month ago

can this issue be assigned to me @programarivm

programarivm commented 1 month ago

@Neel-07 welcome to ChesslaBlab.

Thank you for joining the community, please make sure to read the Contributing Guidelines.

Remember to submit your PR between October 1 and October 31,

I can't wait to see what you come up with!

Neel-07 commented 1 month ago

@programarivm Thanks for the warm welcome to ChesslaBlab! 🎉

I’ve read through the Contributing Guidelines and I’m excited to get started. I’ll make sure to submit my PR between October 1 and October 31.

Neel-07 commented 1 month ago

image

image

@programarivm are the comments appropriate? had a quick question do i need to write the brief description of the heuristic in the comments only at the end of the code or there are some other documentation folder where i need to add the heuristics.

programarivm commented 1 month ago

Thank you @Neel-07 for contributing to this repo!

src/Eval/CheckabilityEval.php is a good example of how to document the code.

Keep it up,