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 documentation comments where they're missing at the moment #1442

Open
ArtOfCode- opened this issue Oct 23, 2024 · 0 comments · May be fixed by #1443
Open

Add documentation comments where they're missing at the moment #1442

ArtOfCode- opened this issue Oct 23, 2024 · 0 comments · May be fixed by #1443
Labels
area: html/css/js Changes to front-end code area: ruby Changes to server-side code complexity: easy Issues that should take limited effort to resolve/fix/build. priority: low type: change request New feature or request

Comments

@ArtOfCode-
Copy link
Member

Our code is woefully lacking in documentation comments across the board. This makes it more difficult for new contributors as they find their way around the project - we should improve on this.

Scope initially should be started with adding comments to classes and methods that are used by other parts of our code. That means utility classes, helper methods, internal APIs etc. It excludes procedural-only code like controller actions, simple JS event handlers, etc. IOW, if it's a method defined in our code and called by our code, it should probably have a comment.

@ArtOfCode- ArtOfCode- added area: ruby Changes to server-side code area: html/css/js Changes to front-end code type: change request New feature or request priority: low complexity: easy Issues that should take limited effort to resolve/fix/build. labels Oct 23, 2024
@ArtOfCode- ArtOfCode- linked a pull request Oct 23, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: html/css/js Changes to front-end code area: ruby Changes to server-side code complexity: easy Issues that should take limited effort to resolve/fix/build. priority: low type: change request New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant