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

The detail CONTRIBUTING.md #650

Open
sunrabbit123 opened this issue Jun 5, 2023 · 2 comments
Open

The detail CONTRIBUTING.md #650

sunrabbit123 opened this issue Jun 5, 2023 · 2 comments

Comments

@sunrabbit123
Copy link
Contributor

sunrabbit123 commented Jun 5, 2023

Feature Request

Your document is excellent.
It will be sufficient for experienced individuals.

However, it is anticipated that there will be significant difficulties for newbies in understanding the structure.
Especially in the area of transformations and coding while grasping the Abstract Syntax Tree (AST), it can be time-consuming.
If there are explanations about the structure or information on where specific functionalities are located, it would reduce the learning curve and make it easier to overcome trial and error.

Thank you for your attention.

@samchon
Copy link
Owner

samchon commented Jun 10, 2023

Welcome your PR

@tsengia
Copy link
Contributor

tsengia commented Oct 28, 2023

@samchon As I am working with Typia, I am noticing some general quality of life improvements that could be made (ie. comments in source code, more developer/maintainer documentation). I'll make a PR eventually with additional docs.

On a side note, should the test/generated/output directory be tracked in git? I ask because I ran the test generation and git status is showing me about 807 files modified, which all seem to be brand new output files! Because it's generated during the test procedure, I have a feeling this should be added to .gitignore...

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