-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
[WIP]: Update contributing #1162
Conversation
@UziTech: Wondering if we should have more detailed descriptions for the various |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should have the variables/functions listed here. They are most likely going to change in the future and this is one more thing we would have to remember to update or it will quickly become stale.
This would be the type of information we should put as comments directly in the code so people reading the code could get a better idea of what everything is. Then when things are updated the comments get updated as well.
I agree with @UziTech. |
I tend to agree as well. Having said that, I'm not sure these things will change that much. The concept of putting them here was to begin teasing out the current architecture for other contributors; namely @intcreator. I will start submitting refactoring PRs with minor code changes and updated comments. We could also run something like TypeDoc over the library to help generate more complete documentation. Tagging @styfle for that one. |
@joshbruce I like what you did in the other PR where the comments linked to the CommonMark spec. I agree with @UziTech and @davisjam — no reason to write out all the functions in the source code here. As for generating docs...it looks like TypeDoc only works with |
@styfle: I only mentioned typedoc as a "sorta like" notion - not a specific solution. This PR will most likely get scaled back. Putting the comments in the code itself will take a bit longer and involved more PRs. Leaving this one alive primarily for the new |
@joshbruce Why not close this PR and create a new one with only the changes that are necessary? |
Honestly? Having it open just made it easy for me to pull up as a reference while submitting the other PRs and I'm not sure what would be left. @UziTech is better equipped to capture a description of each of the |
Marked version: 0.3.19
Markdown flavor: n/a
Description
Update contributing file with description of Marked architecture and other helpful tidbits for contributing to the project.
Contributor
Committer
In most cases, this should be a different person than the contributor.