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 developer notes #77

Open
GitMensch opened this issue Jul 21, 2020 · 0 comments
Open

add developer notes #77

GitMensch opened this issue Jul 21, 2020 · 0 comments

Comments

@GitMensch
Copy link
Contributor

GitMensch commented Jul 21, 2020

I suggest to move what we have in README.md (which is shown to a user of the extension) to a HACKING.md, possibly under "src" and heavily extend this, at least including a note what files are for what.

In general it would be nice to have multi-line comments in the .ts files, I suggest a short header providing the overview "this file contains code for xyz, is triggered by xyz2 and xyz3" and at least include a short ts-doc (I guess something like javadoc exists ...) for each function and global variables.

Yes - the code is not that big currently, but for someone to start it still takes longer than necessary. "Believing in the community" for PR is a reasonable and good thing, to make that happen means to either provide good documentation or extended mentoring (and silly questions on the tracker).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant