-
Notifications
You must be signed in to change notification settings - Fork 499
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 contributing doc and theme template #142
Add contributing doc and theme template #142
Conversation
Co-Authored-By: Michael Schmidt <[email protected]>
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.
Awesome work @hoonweiting!
I have a few suggestions.
Co-authored-by: Michael Schmidt <[email protected]>
Co-authored-by: Michael Schmidt <[email protected]>
I think I'm happy with the docs? Not super sure about the README, the contributing subsection feels a little too short and doesn't mention other ways to contribute! Also added the selectors for overriding the Treeview plugin. |
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.
Sorry for the delay @hoonweiting!
Apart from my comments, I think this is pretty much ready as-is. Just a few minor nits.
Not super sure about the README, the contributing subsection feels a little too short and doesn't mention other ways to contribute!
I think it's fine. A link to the contributing docs is enough and those docs mention more than we ever had.
Co-authored-by: Michael Schmidt <[email protected]>
Co-authored-by: Michael Schmidt <[email protected]>
Mm I'm thinking of adding lines like "You are free to add more properties that aren't stated here, such as |
Yeah, I was thinking about adding something like this too. Maybe just a sentence or two that they are free to add more properties & rules and support for plugins. |
LGTM; Anything else you would like to add or can I merge this? |
I'm good! I mean, I did think about maybe adding another line that tells the reader to delete the instructional comments, but I also think that would be in far-too-detailed territory. Then again, as the person who wrote it, it is probably obvious to me that those instructions can be deleted, whereas an actual user could be completely oblivious. It is hard to make a sound judgement with zero user feedback. |
I agree. Let's get some feedback on this before we make any further additions. Thank you for contributing @hoonweiting! |
Hi! I've created the first draft of the contributing doc and the theme template. I'm not super sure where the template CSS file should go, in the root directory or in some other directory.
Some notes:
I'm using the One Dark colours in the template because I couldn't stand stylelint giving me all those warnings when I left them empty, haha. However, I don't know if this is the best decision, since it can seem opinionated (and One Dark has overrides that aren't just colour).Edit: Changed tounset
Not done with the overrides for the Treeviewer plugin, haven't poked around enough there.Edit: Probably not going to bother