Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docblocks #2

Open
wdelfuego opened this issue Apr 25, 2022 · 0 comments
Open

Add docblocks #2

wdelfuego opened this issue Apr 25, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@wdelfuego
Copy link
Owner

The following files need docblocks:

  • src/DataProvider/MonthCalendar.php
  • src/Http/Controllers/CalendarController.php
  • src/Event.php
  • src/CalendarDay.php

I'm marking this 'good first issue' because it's a small task that will help a lot in getting to understand the internals of this package, and new contributors can do parts of it.

Getting started

  1. Make a clone of this repo and clone that to your own computer
  2. Add the docblocks locally, then commit and push the changes to your repo on GitHub
  3. Send a pull request

Follow the DocBlock guidelines as described by Spatie; most importantly:

Don't use docblocks for methods that can be fully type hinted (unless you need a description).

Any questions or doubts?

Add a comment to this issue and we'll talk about it

@wdelfuego wdelfuego added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 25, 2022
wdelfuego pushed a commit that referenced this issue Aug 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant